Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions get-started/agent-skills.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
---

Check warning on line 1 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L1

Try to keep the Flesch reading ease score (67.07) above 70.

Check warning on line 1 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L1

Try to keep the Coleman–Liau Index grade (9.81) below 9.
title: "Agent skills for AI coding tools"
sidebarTitle: "Agent skills"
description: "Manage GPU workloads on Runpod with coding agents like Claude Code, Codex, and Cursor. Review setup steps and core concepts for building on Runpod."
tag: "NEW"

Check warning on line 5 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L5

Spell out 'NEW', if it's unfamiliar to the audience.
---

The Runpod skills plugin teaches your coding agent how to run GPU workloads on Runpod. Once installed, you can ask your agent to create Pods, deploy Serverless endpoints, transfer files, or deploy your own code with Flash, all in natural language. A built-in router sends each request to the right skill, so you don't need to know which tool applies.

It works with [Claude Code](https://code.claude.com/docs), [Codex](https://github.com/openai/codex), [Cursor](https://cursor.com/), [GitHub Copilot](https://github.com/features/copilot), [Windsurf](https://codeium.com/windsurf), [Cline](https://github.com/cline/cline), and [many other AI agents](https://www.skills.sh/).

<Note>
The skills plugin requires a coding agent with terminal access and Node.js installed (the install command uses `npx`). You can't install it in chat apps like the ChatGPT or Claude mobile apps, which don't provide a shell.
</Note>

## Quick start

Install the skills with a single command that works with every agent:
Expand All @@ -17,7 +21,7 @@
npx skills add runpod/runpod-plugins-official
```

Next, install the Runpod CLI that the skills rely on (skip this if you already have it):

Check warning on line 24 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L24

Use 'command-line tool' instead of 'CLI'.

Check warning on line 24 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L24

Use parentheses judiciously.

```bash
curl -sSL https://cli.runpod.net | bash
Expand All @@ -25,7 +29,7 @@
brew install runpod/runpodctl/runpodctl
```

Then authenticate with your [Runpod API key](/get-started/api-keys). The same key works for the CLI, Flash, and the bundled MCP server:

Check warning on line 32 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L32

Use 'command-line tool' instead of 'CLI'.

Check warning on line 32 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L32

Spell out 'MCP', if it's unfamiliar to the audience.

```bash
# Set the key for the current shell (add to ~/.zshrc or ~/.bashrc to persist):
Expand All @@ -35,15 +39,15 @@
runpodctl doctor
```

That's it — restart your agent and [get started](#getting-started).

Check warning on line 42 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L42

Don't put a space before or after a dash.

## Getting started

There are no commands to memorize: describe what you want, and the router picks the right skill (prompting you if something like an API key is still missing). Confirm it's wired up by asking:

Check warning on line 46 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L46

Use parentheses judiciously.

- "List my Runpod endpoints"

Check warning on line 48 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L48

Avoid first-person pronouns such as 'my'.

If your endpoints come back, you're set — see [What you can do](#what-you-can-do) for more examples.

Check warning on line 50 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L50

Don't put a space before or after a dash.

## What's included

Expand All @@ -52,12 +56,12 @@
| Skill | Description |
|-------|-------------|
| **runpod** | Router and entry point. Reads your task and hands it to the right skill. |
| **runpod-mcp** | Manages Pods, endpoints, templates, network volumes, registries, and billing through the Runpod MCP server. |

Check warning on line 59 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L59

Spell out 'MCP', if it's unfamiliar to the audience.
| **runpodctl** | Manages the same resources from the [Runpod CLI](/runpodctl/overview), plus Hub deployments, file transfers, SSH keys, and model caching. |

Check warning on line 60 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L60

Use 'command-line tool' instead of 'CLI'.
| **flash** | Writes and deploys your own Python code to Runpod Serverless using the [runpod-flash](/flash/overview) SDK. |
| **companion-clis** | Uses supporting CLIs such as Hugging Face, Docker, and the AWS CLI when a task needs them. |

Check warning on line 62 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L62

Spell out 'AWS', if it's unfamiliar to the audience.

Check warning on line 62 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L62

Use 'command-line tool' instead of 'CLI'.
| **runpod-usage** | Provides conceptual knowledge about Pods, Serverless, storage, and GPU selection. |
| **runpod-migrate** | Migrates a codebase from the GraphQL API or REST v1 to REST v2. It inventories which API each call site uses, rewrites the call sites, and verifies the result. |

Check warning on line 64 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L64

Spell out 'REST', if it's unfamiliar to the audience.

Check warning on line 64 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L64

Spell out 'REST', if it's unfamiliar to the audience.

The plugin also includes a collection of worked, end-to-end reference tasks, such as deploying a Whisper endpoint or running a model on a Pod, that guide your agent through common workflows.

Expand All @@ -67,18 +71,18 @@

| Category | Example prompt |
|----------|----------------|
| Create resources | "Create a Pod with an RTX 4090" |

Check warning on line 74 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L74

Spell out 'RTX', if it's unfamiliar to the audience.
| List resources | "List my Pods" or "Show my Serverless endpoints" |

Check warning on line 75 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L75

Avoid first-person pronouns such as 'my'.

Check warning on line 75 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L75

Avoid first-person pronouns such as 'my'.
| GPU availability | "What GPUs are available?" |
| Account info | "Show my account balance" |

Check warning on line 77 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L77

Avoid first-person pronouns such as 'my'.
| Deploy endpoints | "Deploy a Serverless endpoint using my template" |

Check warning on line 78 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L78

Avoid first-person pronouns such as 'my'.
| Manage Pods | "Stop my Pod" or "SSH into my Pod" |

Check warning on line 79 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L79

Avoid first-person pronouns such as 'my'.

Check warning on line 79 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L79

Avoid first-person pronouns such as 'my'.
| Deploy with Flash | "Deploy this function to a remote GPU with Flash" |
| Local development | "Start a local dev server with Flash" |

## Migrate an existing integration

If you already have an integration built on the GraphQL API or REST v1, the `/runpod:migrate` command moves it to REST v2. It inventories which API version each part of your code uses, then rewrites the call sites, flags breaking changes, and verifies the result. It migrates one file at a time, with one commit per file.

Check warning on line 85 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L85

Spell out 'REST', if it's unfamiliar to the audience.

Check warning on line 85 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L85

Spell out 'REST', if it's unfamiliar to the audience.

Because it edits and commits your code as it goes, run it on a feature branch and review each commit before you merge or deploy.

Expand All @@ -88,19 +92,19 @@
/runpod:migrate [scope: all | rest | graphql] [path]
```

`scope` defaults to `all`, which covers both REST v1 and GraphQL. Use `rest` to target REST v1 only, or `graphql` to target GraphQL only. `path` defaults to the current directory. For example, to migrate only the REST v1 code under `src/`:

Check warning on line 95 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L95

Spell out 'REST', if it's unfamiliar to the audience.

Check warning on line 95 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L95

Spell out 'REST', if it's unfamiliar to the audience.

Check warning on line 95 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L95

Spell out 'REST', if it's unfamiliar to the audience.

```bash
/runpod:migrate rest src/
```

Running the command requires the Runpod skills plugin installed in your coding agent (see [Quick start](#quick-start)). For a manual walkthrough of the API changes, see the [migration guide](/api-reference-v2/migrate-from-v1).

Check warning on line 101 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L101

Use parentheses judiciously.

## Native install options

The `npx skills add` command above works everywhere. If you'd rather install the plugin through your agent's native marketplace, use the route for your agent below. Each route installs the same router and skills.

Check warning on line 105 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L105

Use 'preceding' instead of 'above'.

### Claude Code

Check warning on line 107 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L107

'Claude Code' should use sentence-style capitalization.

Add the marketplace, install the plugin, then reload:

Expand All @@ -110,7 +114,7 @@
/reload-plugins
```

Installing the plugin also wires up the hosted Runpod MCP server. To authenticate it, run `/mcp`, select **runpod**, and choose **Sign in with Runpod**.

Check warning on line 117 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L117

Spell out 'MCP', if it's unfamiliar to the audience.

### Codex

Expand All @@ -118,7 +122,7 @@
codex plugin marketplace add https://github.com/runpod/runpod-plugins-official.git
```

Run `codex /plugins`, open the **Runpod** tab, and install (reload if prompted). If the Runpod MCP tools don't appear, add the hosted server manually:

Check warning on line 125 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L125

Use parentheses judiciously.

Check warning on line 125 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L125

Spell out 'MCP', if it's unfamiliar to the audience.

```bash
codex mcp add runpod --transport http https://mcp.getrunpod.io/
Expand All @@ -128,15 +132,15 @@

Gemini can install the plugin natively through the bundled `gemini-extension.json`. Follow your client's extension documentation to add it.

## Connecting the MCP server on other agents

Check warning on line 135 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L135

Spell out 'MCP', if it's unfamiliar to the audience.

The hosted Runpod MCP server gives your agent structured control-plane tools for managing Pods, endpoints, and other resources. Claude Code sets it up automatically during a native install. On other agents, run the guided installer, which detects your agent and configures the connection:

Check warning on line 137 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L137

Spell out 'MCP', if it's unfamiliar to the audience.

```bash
npx @runpod/mcp-server@latest add
```

The installer authenticates the MCP server for you. To reuse the API key you already set instead, pass it as a bearer header when you add the server. For example, in Claude Code:

Check warning on line 143 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L143

Spell out 'MCP', if it's unfamiliar to the audience.

```bash
claude mcp add --transport http runpod -s user https://mcp.getrunpod.io/ \
Expand All @@ -145,7 +149,7 @@

## Update and uninstall

To update the plugin to the latest version:

Check warning on line 152 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L152

Avoid time-based words like 'latest' in product documentation.

```bash
# Claude Code:
Expand Down Expand Up @@ -173,7 +177,7 @@
npx skills remove runpod
```

If a command reports a name mismatch, list what's installed first with `/plugin marketplace list` (Claude Code), `codex plugin marketplace list` (Codex), or `npx skills list` (skills.sh), then use the name shown.

Check warning on line 180 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L180

Use parentheses judiciously.

Check warning on line 180 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L180

Use parentheses judiciously.

Check warning on line 180 in get-started/agent-skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

get-started/agent-skills.mdx#L180

Use parentheses judiciously.

## Learn more

Expand Down
4 changes: 3 additions & 1 deletion pods/pricing.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---

Check warning on line 1 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L1

Try to keep the Flesch–Kincaid grade level (9.35) below 8.

Check warning on line 1 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L1

Try to keep the Flesch reading ease score (57.40) above 70.

Check warning on line 1 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L1

Try to keep the Gunning-Fog index (10.17) below 10.

Check warning on line 1 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L1

Try to keep the Coleman–Liau Index grade (10.86) below 9.

Check warning on line 1 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L1

Try to keep the LIX score (45.55) below 35.

Check warning on line 1 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L1

Try to keep the Automated Readability Index (9.60) below 8.

Check warning on line 1 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L1

Try to keep the SMOG grade (10.77) below 10.
title: "Pricing"
sidebarTitle: "Pricing"
description: "Explore pricing options for Pods, including on-demand and savings plans. Review setup, configuration, and operations guidance for Runpod Pods."
Expand All @@ -13,19 +13,21 @@
Runpod offers custom pricing plans for large scale and enterprise workloads. [Contact our sales team](https://ecykq.share.hsforms.com/2MZdZATC3Rb62Dgci7knjbA) to learn more.
</Tip>

Pods are billed by the second for compute and storage, with no fees for data ingress or egress. Find the latest GPU pricing on the [Runpod console](https://www.console.runpod.io/pods) during Pod deployment.
Pods are billed by the second for compute and storage, with no fees for data ingress or egress.

Check warning on line 16 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L16

In general, use active voice instead of passive voice ('are billed').

The documentation doesn't list per-GPU hourly rates or savings plan discounts because they vary by GPU type and cloud type (Secure or Community) and change over time. Find current rates on the [Runpod pricing page](https://www.runpod.io/pricing) or in the [Runpod console](https://www.console.runpod.io/pods) during Pod deployment.

Check warning on line 18 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L18

Use parentheses judiciously.

## Pricing options

| | On-demand | Savings plan |
|---|-----------|--------------|
| **Pricing** | Standard hourly rate | Discounted (prepaid) |

Check warning on line 24 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L24

Use parentheses judiciously.
| **Commitment** | None | 3 or 6 months upfront |
| **Best for** | Development, testing, variable workloads | Long-running production workloads |

Check warning on line 26 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L26

Avoid the unverifiable claim 'Best'.

### On-demand

Pay-as-you-go pricing. Resources are dedicated to your Pod and cannot be displaced by other users.

Check warning on line 30 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L30

In general, use active voice instead of passive voice ('are dedicated').

Check warning on line 30 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L30

Use 'can't' instead of 'cannot'.

Check warning on line 30 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L30

In general, use active voice instead of passive voice ('be displaced').

<Warning>
You must have at least one hour's worth of credits for your selected configuration to deploy an on-demand instance.
Expand All @@ -43,12 +45,12 @@

| Storage type | Running Pod | Stopped Pod | Notes |
|--------------|-------------|-------------|-------|
| **Container disk** | \$0.10/GB/month | Not charged | Temporary; erased when Pod stops |

Check warning on line 48 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L48

Use semicolons judiciously.
| **Volume disk** | \$0.10/GB/month | \$0.20/GB/month | Persistent; retained until Pod deleted |

Check warning on line 49 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L49

Use semicolons judiciously.
| **Network volume** | \$0.07/GB/month (< 1TB) | \$0.07/GB/month | Permanent; portable between Pods |

Check warning on line 50 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L50

Use parentheses judiciously.

Check warning on line 50 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L50

Put a nonbreaking space between the number and the unit in '1TB'.

Check warning on line 50 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L50

Use semicolons judiciously.
| | \$0.05/GB/month (> 1TB) | \$0.05/GB/month | |

Check warning on line 51 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L51

Use parentheses judiciously.

Check warning on line 51 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L51

Put a nonbreaking space between the number and the unit in '1TB'.

Storage is billed per-second for container and volume disks, and hourly for network volumes. You are not charged if the host <MachineTooltip /> is unavailable.

Check warning on line 53 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L53

In general, use active voice instead of passive voice ('is billed').

Check warning on line 53 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L53

Use 'aren't' instead of 'are not'.

<Note>
Runpod is not designed for long-term cloud storage. Back up critical data to your local machine or a dedicated storage provider.
Expand All @@ -56,7 +58,7 @@

## Account limits

- **Minimum balance**: Pods are automatically stopped when your account balance reaches \$0. Pods with a network volume are stopped and their data is preserved, while Pods without a network volume are terminated and their data cannot be recovered. To avoid interruptions, enable [low balance notifications](/accounts-billing/billing#low-balance-notifications) or set up [auto-pay](https://www.console.runpod.io/user/billing).

Check warning on line 61 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L61

In general, use active voice instead of passive voice ('are stopped').

Check warning on line 61 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L61

In general, use active voice instead of passive voice ('is preserved').

Check warning on line 61 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L61

In general, use active voice instead of passive voice ('are terminated').

Check warning on line 61 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L61

Use 'can't' instead of 'cannot'.

Check warning on line 61 in pods/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

pods/pricing.mdx#L61

In general, use active voice instead of passive voice ('be recovered').
- **Spend limit**: Default limit of \$80/hour across all resources. [Contact support](https://www.runpod.io/contact) to increase.

## Track your costs
Expand Down
6 changes: 5 additions & 1 deletion serverless/endpoints/endpoint-configurations.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---

Check warning on line 1 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L1

Try to keep the Flesch reading ease score (46.27) above 70.

Check warning on line 1 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L1

Try to keep the SMOG grade (11.34) below 10.

Check warning on line 1 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L1

Try to keep the Flesch–Kincaid grade level (9.71) below 8.

Check warning on line 1 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L1

Try to keep the Automated Readability Index (9.26) below 8.

Check warning on line 1 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L1

Try to keep the LIX score (45.35) below 35.

Check warning on line 1 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L1

Try to keep the Coleman–Liau Index grade (12.68) below 9.
title: "Endpoint settings"
sidebarTitle: "Endpoint settings"
description: "Reference guide for all Serverless endpoint settings and parameters. Review configuration and operations guidance for Runpod Serverless."
Expand All @@ -17,27 +17,27 @@

| Setting | Default | Description |
|---------|---------|-------------|
| **Active workers** | 0 | Always-on workers (eliminates cold starts) |

Check warning on line 20 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L20

Use parentheses judiciously.
| **Max workers** | 3 | Maximum concurrent workers |
| **GPUs per worker** | 1 | GPU count per worker instance |
| **Idle timeout** | 5s | Time before idle worker shuts down |

Check warning on line 23 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L23

Put a nonbreaking space between the number and the unit in '5s'.
| **Execution timeout** | 600s (10 min) | Max job duration |

Check warning on line 24 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L24

Put a nonbreaking space between the number and the unit in '600s'.

Check warning on line 24 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L24

Use parentheses judiciously.
| **Job TTL** | 24h | Total job lifespan in system |

Check warning on line 25 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L25

Spell out 'TTL', if it's unfamiliar to the audience.

Check warning on line 25 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L25

Put a nonbreaking space between the number and the unit in '24h'.
| **FlashBoot** | Enabled | Faster cold starts via state retention |

## General configuration

### Endpoint name

Display name for identifying your endpoint in the console. Does not affect the endpoint ID used for API requests.

Check warning on line 32 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L32

Use 'doesn't' instead of 'Does not'.

### Endpoint type

**Queue-based endpoints** use a built-in queueing system with guaranteed execution and automatic retries. Ideal for async tasks, batch processing, and long-running jobs. Implemented using [handler functions](/serverless/workers/handler-functions).

**Load balancing endpoints** route traffic directly to workers, bypassing the queue. Designed for low-latency applications like real-time <InferenceTooltip /> or custom REST APIs. See [Load balancing endpoints](/serverless/load-balancing/overview).

Check warning on line 38 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L38

Spell out 'REST', if it's unfamiliar to the audience.

### GPU configuration

Check warning on line 40 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L40

'GPU configuration' should use sentence-style capitalization.

Determines the hardware tier for your workers. Select multiple GPU categories to create a prioritized fallback list. If your first choice is unavailable, Runpod automatically uses the next option. Selecting multiple types improves availability during high demand.

Expand All @@ -47,7 +47,7 @@

Specify up to three GPU types in priority order when configuring an endpoint. Runpod uses this ranking to distribute workers across available GPUs, improving availability during high demand.

For endpoints with five or more workers, Runpod distributes workers across your selected GPU priorities. Most workers run on your primary GPU type, with fewer assigned to secondary and tertiary selections. This reduces throttling when your primary GPU is constrained.

Check warning on line 50 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L50

Use the Oxford comma in ', with fewer assigned to secondary and tertiary selections.'.

Check warning on line 50 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L50

In general, use active voice instead of passive voice ('is constrained').

For endpoints with fewer than five workers, all workers use the highest-priority GPU type available.

Expand All @@ -61,15 +61,15 @@

Maximum concurrent instances your endpoint can scale to. Acts as a cost safety limit and concurrency cap. Set ~20% higher than expected max concurrency to handle traffic spikes smoothly.

### GPUs per worker

Check warning on line 64 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L64

'GPUs per worker' should use sentence-style capitalization.

Number of GPUs assigned to each worker instance. Default is 1. Generally prioritize fewer high-end GPUs over multiple lower-tier GPUs.

### Auto-scaling type

**Queue delay**: Adds workers when requests wait longer than the threshold (default: 4 seconds). Best when slight delays are acceptable for higher utilization.

Check warning on line 70 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L70

'Adds' should be in lowercase.

Check warning on line 70 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L70

Use parentheses judiciously.

Check warning on line 70 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L70

Avoid the unverifiable claim 'Best'.

**Request count**: More aggressive scaling based on pending + active work. Formula: `Math.ceil((requestsInQueue + requestsInProgress) / scalerValue)`. Use scaler value of 1 for max responsiveness. Recommended for LLM workloads or frequent short requests.

Check warning on line 72 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L72

'More' should be in lowercase.

Check warning on line 72 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L72

Spell out 'LLM', if it's unfamiliar to the audience.

## Lifecycle and timeouts

Expand All @@ -80,24 +80,24 @@
### Idle endpoint scale-down

Runpod automatically scales down endpoints that go a long time without any requests, so unused endpoints don't keep consuming your account balance.
* After 3 days with no requests, the endpoint's max workers is reduced to 2 and Runpod sends you an email notification.

Check warning on line 83 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L83

In general, use active voice instead of passive voice ('is reduced').
* After 7 days with no requests, max workers is set to 0.

Check warning on line 84 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L84

In general, use active voice instead of passive voice ('is set').

This scale-down is automatic and system-driven, and the timer is based on request activity, so any incoming request resets it.

Check warning on line 86 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L86

In general, use active voice instead of passive voice ('is based').

Once an endpoint has been scaled down this way, it stays at its reduced max workers until you raise the value yourself. To use the endpoint again, increase its max workers in the Runpod console. To prevent an endpoint from scaling down in the first place, make sure it continues to receive requests.

Check warning on line 88 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L88

In general, use active voice instead of passive voice ('been scaled').

### Execution timeout

Maximum duration for a single job. When exceeded, the job fails and the worker stops. Keep enabled to prevent runaway jobs. Default: 600s (10 min). Range: 5s to 7 days.

Check warning on line 92 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L92

Put a nonbreaking space between the number and the unit in '600s'.

Check warning on line 92 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L92

Use parentheses judiciously.

Check warning on line 92 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L92

Put a nonbreaking space between the number and the unit in '5s'.

Configure in **Advanced** settings, or override per-request via `executionTimeout` in the [job policy](/serverless/endpoints/send-requests#execution-policies).

### Job TTL (time-to-live)

Check warning on line 96 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L96

'Job TTL (time-to-live)' should use sentence-style capitalization.

Check warning on line 96 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L96

Spell out 'TTL', if it's unfamiliar to the audience.

Check warning on line 96 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L96

Use parentheses judiciously.

Total lifespan of a job in the system. When TTL expires, job data is deleted regardless of state (queued, running, or completed). Default: 24 hours. Range: 10s to 7 days.

Check warning on line 98 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L98

Spell out 'TTL', if it's unfamiliar to the audience.

Check warning on line 98 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L98

In general, use active voice instead of passive voice ('is deleted').

Check warning on line 98 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L98

Use parentheses judiciously.

Check warning on line 98 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L98

Put a nonbreaking space between the number and the unit in '10s'.

The timer starts at submission, not execution. If a job queues for 45 minutes with a 1-hour TTL, only 15 minutes remain for execution.

Check warning on line 100 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L100

Spell out 'TTL', if it's unfamiliar to the audience.

<Warning>
TTL is a hard limit. If it expires while a job is running, the job is immediately removed and status checks return 404. Set TTL to cover both expected queue time and execution time.
Expand All @@ -110,16 +110,20 @@
| Request type | Retention | Notes |
|--------------|-----------|-------|
| Async (`/run`) | 30 min | Retrieve via `/status/{job_id}` |
| Sync (`/runsync`) | 1 min | Returned in response; also available via `/status/{job_id}` |

Check warning on line 113 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L113

Use semicolons judiciously.

Results are permanently deleted after retention expires.

## Performance features

### FlashBoot

Check warning on line 119 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L119

'FlashBoot' should use sentence-style capitalization.

Reduces cold starts by retaining worker state after spin-down, allowing faster "revival" than fresh boots. Most effective on endpoints with consistent traffic where workers frequently cycle between active and idle.
Both new GPU and CPU endpoints will have FlashBoot enabled by default, and you can edit existing endpoints to enable or disable FlashBoot.
New GPU and CPU endpoints have FlashBoot enabled by default, and you can edit existing endpoints to enable or disable it.

Check warning on line 122 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L122

Use 'turn off' or 'off' instead of 'disable'.

State retention is best-effort, not guaranteed. If a worker's retained state is no longer available, for example after a long period without traffic, the worker starts with a standard cold start instead. To guarantee low latency, set [active workers](#active-workers) above zero.

Check warning on line 124 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L124

Avoid the unverifiable claim 'best'.

Check warning on line 124 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L124

Avoid the unverifiable claim 'guarantee'.

Check warning on line 124 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L124

Use 'preceding' instead of 'above'.

When managing endpoints through the [REST API](/api-reference-v2/serverless/create-a-serverless-endpoint), the `flashboot` field accepts three modes: `OFF`, `FLASHBOOT`, and `PRIORITY_FLASHBOOT` (FlashBoot with priority capacity).

Check warning on line 126 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L126

Spell out 'REST', if it's unfamiliar to the audience.

Check warning on line 126 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L126

Use parentheses judiciously.

### Model

Expand All @@ -135,10 +139,10 @@

[Network volumes](/storage/network-volumes) provide persistent storage across worker restarts. Tradeoffs: adds network latency and restricts your endpoint to the volume's data center. Use only when you need shared persistence or datasets exceeding container limits.

### CUDA version selection

Check warning on line 142 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L142

Spell out 'CUDA', if it's unfamiliar to the audience.

Check warning on line 142 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L142

'CUDA version selection' should use sentence-style capitalization.

Ensures workers run on <MachinesTooltip /> with compatible drivers. Select your required version plus all newer versions, since CUDA is backward compatible and a wider range increases available hardware.

Check warning on line 144 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L144

Spell out 'CUDA', if it's unfamiliar to the audience.

### Expose HTTP/TCP ports

Check warning on line 146 in serverless/endpoints/endpoint-configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/endpoint-configurations.mdx#L146

'Expose HTTP/TCP ports' should use sentence-style capitalization.

Exposes the worker's public IP and port for direct external communication. Required for persistent connections like WebSockets.
16 changes: 15 additions & 1 deletion serverless/endpoints/send-requests.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---

Check warning on line 1 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L1

Try to keep the Gunning-Fog index (10.66) below 10.

Check warning on line 1 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L1

Try to keep the LIX score (45.32) below 35.

Check warning on line 1 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L1

Try to keep the Automated Readability Index (9.77) below 8.

Check warning on line 1 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L1

Try to keep the Flesch–Kincaid grade level (9.79) below 8.

Check warning on line 1 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L1

Try to keep the Coleman–Liau Index grade (12.46) below 9.

Check warning on line 1 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L1

Try to keep the Flesch reading ease score (49.19) above 70.

Check warning on line 1 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L1

Try to keep the SMOG grade (11.43) below 10.
title: "Send API requests"
sidebarTitle: "Send API requests"
description: "Submit and manage jobs for your queue-based endpoints by sending HTTP requests. Review configuration and operations guidance for Runpod Serverless."
Expand All @@ -21,13 +21,13 @@

## How requests work

A **job** is a unit of work containing the input data from the request, packaged for processing by your [workers](/serverless/workers/overview). If no worker is immediately available, the job is queued. Once a worker is available, the job is processed using your worker's [handler function](/serverless/workers/handler-functions).

Check warning on line 24 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L24

In general, use active voice instead of passive voice ('is queued').

Check warning on line 24 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L24

In general, use active voice instead of passive voice ('is processed').

## Sync vs. async

- `/runsync` submits a **synchronous** job.
- Client waits for the job to complete before returning the result.
- Results are available for 1 minute (5 minutes max).

Check warning on line 30 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L30

Use parentheses judiciously.
- Ideal for quick responses and interactive applications.
- `/run` submits an **asynchronous** job.
- The job processes in the background; retrieve results via `/status`.
Expand Down Expand Up @@ -71,7 +71,7 @@
| `/cancel` | POST | Stop a job in progress or waiting in the queue. |
| `/retry` | POST | Requeue a failed or timed-out job with the same job ID and input. |
| `/purge-queue` | POST | Clear all pending jobs from the queue. |
| `/health` | GET | Monitor endpoint status, including worker and job statistics. |

Check warning on line 74 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L74

Use the Oxford comma in ', including worker and job statistics.'.

See the [operation reference](/serverless/endpoints/operation-reference) for detailed examples using cURL and the Runpod SDK.

Expand All @@ -81,7 +81,7 @@

## Advanced options

Beyond the required `input` object, you can include optional top-level parameters for additional functionality.

Check warning on line 84 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L84

Use 'capability' or 'feature' instead of 'functionality'.

### Webhook notifications

Expand All @@ -94,7 +94,21 @@
}
```

Your webhook should return a `200` status code. If the call fails, Runpod retries up to 2 more times with a 10-second delay.
When your job completes, Runpod sends a `POST` request to your webhook URL. The request body contains the same information as the [`/status` operation](/serverless/endpoints/operation-reference#status), including the job `id`, `status`, and `output`:

```json
{
"delayTime": 31618,
"executionTime": 1437,
"id": "60902e6c-08a1-426e-9cb9-9eaec90f5e2b-u1",
"output": {
"text": ["Your job results here"]
},
"status": "COMPLETED"
}
```

Your webhook should return a `200` status code to acknowledge receipt. If the call fails, Runpod retries up to 2 more times with a 10-second delay between attempts.

### Execution policies

Expand All @@ -113,17 +127,17 @@

| Option | Description | Default | Constraints |
|--------------------|----------------------------------------------------------|----------------------|-------------------------|
| `executionTimeout` | Maximum time a job can run while being processed | 600000 (10 minutes) | Min 5 sec, max 7 days |

Check warning on line 130 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L130

In general, use active voice instead of passive voice ('being processed').

Check warning on line 130 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L130

Use parentheses judiciously.
| `lowPriority` | When true, job won't trigger worker scaling | false | - |
| `ttl` | Total lifespan of the job before deletion | 86400000 (24 hours) | Min 10 sec, max 7 days |

Check warning on line 132 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L132

Use parentheses judiciously.

<Info>
Setting `executionTimeout` in a request overrides the default endpoint setting for that specific job only.
</Info>

#### TTL vs. execution timeout

Check warning on line 138 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L138

'TTL vs. execution timeout' should use sentence-style capitalization.

Check warning on line 138 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L138

Spell out 'TTL', if it's unfamiliar to the audience.

- **`ttl`**: Total lifespan of the job. Timer starts when submitted and covers queue time, execution time, and everything in between. When TTL expires, the job is deleted regardless of state.

Check warning on line 140 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L140

Spell out 'TTL', if it's unfamiliar to the audience.

Check warning on line 140 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L140

In general, use active voice instead of passive voice ('is deleted').
- **`executionTimeout`**: Maximum time the job can actively run once a worker picks it up. Only enforced during execution.

<Warning>
Expand All @@ -132,7 +146,7 @@

#### Long-running jobs

For jobs that need to run longer than the default 24-hour TTL:

Check warning on line 149 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L149

Spell out 'TTL', if it's unfamiliar to the audience.

1. Set `executionTimeout` to your desired maximum runtime.
2. Set `ttl` to cover **both expected queue time and execution time**.
Expand All @@ -147,7 +161,7 @@
}
```

This allows up to 48 hours of active runtime with 72 hours total lifespan (24 hours headroom for queue time).

Check warning on line 164 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L164

Use parentheses judiciously.

<Warning>
Both `ttl` and `executionTimeout` have a maximum of 7 days. A job with 7-day TTL that queues for 2 days only has 5 days remaining for execution.
Expand All @@ -155,12 +169,12 @@

#### Result retention

After completion, results are retained for a fixed period separate from TTL:

Check warning on line 172 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L172

In general, use active voice instead of passive voice ('are retained').

Check warning on line 172 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L172

Spell out 'TTL', if it's unfamiliar to the audience.

| Request type | Retention period |
|--------------------|------------------|
| `/run` (async) | 30 minutes |

Check warning on line 176 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L176

Use parentheses judiciously.
| `/runsync` (sync) | 1 minute |

Check warning on line 177 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L177

Use parentheses judiciously.

### S3-compatible storage

Expand Down Expand Up @@ -199,7 +213,7 @@

Rate limits scale with your endpoint's worker count. The system uses whichever is higher between:

1. **Base limit**: Fixed rate limit per user per endpoint (shown above)

Check warning on line 216 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L216

Use parentheses judiciously.

Check warning on line 216 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L216

Use 'preceding' instead of 'above'.
2. **Worker-based limit**: `number_of_running_workers × requests_per_worker`

Requests exceeding the effective limit return `429 (Too Many Requests)`. Implement retry logic with exponential backoff to handle rate limiting gracefully.
Expand All @@ -214,13 +228,13 @@
| 401 | Unauthorized | Verify your API key is correct and has permission |
| 404 | Not Found | Check your endpoint ID |
| 429 | Too Many Requests | Implement backoff and retry logic |
| 500 | Internal Server Error | Check endpoint logs; worker may have crashed |

Check warning on line 231 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L231

Use semicolons judiciously.

| Issue | Possible Causes | Solutions |
|--------------------|------------------------------------------|---------------------------------------------------------------------|
| Job stuck in queue | No available workers, max workers reached | Increase max workers, check endpoint health |
| Timeout errors | Job takes longer than execution timeout | Increase timeout in job policy, optimize processing |
| Failed jobs | Worker errors, input validation issues | Check [endpoint logs](/serverless/development/logs), verify input |
| Missing results | Results expired | Retrieve within expiration window (30 min async, 1 min sync) |

Check warning on line 238 in serverless/endpoints/send-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/endpoints/send-requests.mdx#L238

Use parentheses judiciously.

See [error handling](/serverless/workers/handler-functions#error-handling) for implementation details.
2 changes: 2 additions & 0 deletions serverless/pricing.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---

Check warning on line 1 in serverless/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/pricing.mdx#L1

Try to keep the Automated Readability Index (9.53) below 8.

Check warning on line 1 in serverless/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/pricing.mdx#L1

Try to keep the LIX score (47.70) below 35.

Check warning on line 1 in serverless/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/pricing.mdx#L1

Try to keep the Coleman–Liau Index grade (12.91) below 9.

Check warning on line 1 in serverless/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/pricing.mdx#L1

Try to keep the Flesch reading ease score (49.63) above 70.

Check warning on line 1 in serverless/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/pricing.mdx#L1

Try to keep the SMOG grade (10.74) below 10.

Check warning on line 1 in serverless/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/pricing.mdx#L1

Try to keep the Flesch–Kincaid grade level (9.31) below 8.
title: "Pricing"
sidebarTitle: "Pricing"
description: "Learn how Serverless billing works to optimize your costs. Review setup, configuration, deployment, and operations guidance for Runpod Serverless."
Expand All @@ -13,13 +13,15 @@

Serverless offers pay-per-second pricing with no upfront costs. You're billed from when a worker starts until it fully stops, rounded up to the nearest second.

The documentation doesn't list per-GPU rates because they vary by GPU type and change over time. Find current rates on the [Runpod pricing page](https://www.runpod.io/pricing) or in the Runpod console when creating an endpoint. To estimate a job's cost, multiply the listed hourly rate by your expected worker runtime.

## Worker types

| | Flex workers | Active workers |
|---|--------------|----------------|
| **Behavior** | Scale to zero when idle | Always running (24/7) |

Check warning on line 22 in serverless/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/pricing.mdx#L22

Use parentheses judiciously.
| **Pricing** | Standard per-second rate | Discounts available through sales inquiry |
| **Best for** | Variable workloads, cost optimization | Consistent traffic, low-latency requirements |

Check warning on line 24 in serverless/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/pricing.mdx#L24

Avoid the unverifiable claim 'Best'.

## What you're billed for

Expand All @@ -28,8 +30,8 @@
| Cost component | Description | Rate |
|----------------|-------------|------|
| **Compute** | GPU time while workers run | See the [Runpod pricing page](https://www.runpod.io/pricing) |
| **Container disk** | Worker storage (5-min intervals) | ~\$0.10/GB/month |

Check warning on line 33 in serverless/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/pricing.mdx#L33

Use parentheses judiciously.
| **Network volume** | Shared persistent storage | \$0.07/GB/month (< 1TB), \$0.05/GB/month (> 1TB) |

Check warning on line 34 in serverless/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/pricing.mdx#L34

Use parentheses judiciously.

Check warning on line 34 in serverless/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/pricing.mdx#L34

Put a nonbreaking space between the number and the unit in '1TB'.

Check warning on line 34 in serverless/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/pricing.mdx#L34

Use parentheses judiciously.

Check warning on line 34 in serverless/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/pricing.mdx#L34

Put a nonbreaking space between the number and the unit in '1TB'.

### Compute cost breakdown

Expand All @@ -39,7 +41,7 @@

2. **Execution time**: Processing requests. Set [execution timeouts](/serverless/endpoints/endpoint-configurations#execution-timeout) to prevent runaway jobs.

3. **Idle timeout duration**: The time a worker remains active (running) after completing a request, waiting for additional requests before scaling down (default: 5 seconds). Configure in [endpoint settings](/serverless/endpoints/endpoint-configurations#idle-timeout).

Check warning on line 44 in serverless/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/pricing.mdx#L44

Use parentheses judiciously.

Check warning on line 44 in serverless/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/pricing.mdx#L44

Use parentheses judiciously.

<Tip>
For high-volume workloads with significant storage needs, use [network volumes](/storage/network-volumes) to share data across workers and reduce per-worker storage costs.
Expand All @@ -47,12 +49,12 @@

## Account limits

**Spend limit**: Default limit of \$80/hour across all resources. [Contact support](https://www.runpod.io/contact) to increase.

Check warning on line 52 in serverless/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/pricing.mdx#L52

'Default' should be in lowercase.

## Billing support

If you believe you've been billed incorrectly, [contact support](https://www.runpod.io/contact), including the following information in your ticket:

Check warning on line 56 in serverless/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/pricing.mdx#L56

In general, use active voice instead of passive voice ('been billed').

- Endpoint ID
- Request ID (if applicable)

Check warning on line 59 in serverless/pricing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

serverless/pricing.mdx#L59

Use parentheses judiciously.
- Approximate time of the issue
Loading