Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
458a893
docs: enforce second-person voice and click/select consistency in Fla…
mintlify[bot] Aug 13, 2026
a263708
Merge remote-tracking branch 'origin/main' into mintlify/aa04a79a
mintlify[bot] Aug 13, 2026
da07188
docs: standardize UI action verb to "select" in Flash apps guide
mintlify[bot] Aug 13, 2026
086fd36
Merge remote-tracking branch 'origin/main' into mintlify/aa04a79a
mintlify[bot] Aug 13, 2026
b4a9af3
docs: split compound sentences in Flash local-module docs for clarity
mintlify[bot] Aug 13, 2026
d40a53e
Merge remote-tracking branch 'origin/main' into mintlify/aa04a79a
mintlify[bot] Aug 18, 2026
bb61683
docs: split long fitness-checks summary sentence in serverless overview
mintlify[bot] Aug 18, 2026
2c920e1
Merge remote-tracking branch 'origin/main' into mintlify/aa04a79a
mintlify[bot] Aug 18, 2026
7c6c0c7
docs: remove em-dash clause joiners and fix list lede in v1-to-v2 mig…
mintlify[bot] Aug 18, 2026
3d539ea
Merge remote-tracking branch 'origin/main' into mintlify/aa04a79a
mintlify[bot] Aug 18, 2026
0b6783c
docs: split long v2 GA sentence and capitalize Pod in release notes
mintlify[bot] Aug 18, 2026
532aa43
Merge remote-tracking branch 'origin/main' into mintlify/aa04a79a
mintlify[bot] Aug 19, 2026
72c6857
docs: capitalize Pod, remove em-dash joiners, and terminate list bull…
mintlify[bot] Aug 19, 2026
e3bc5d3
Merge remote-tracking branch 'origin/main' into mintlify/aa04a79a
mintlify[bot] Aug 20, 2026
b272e48
docs: keep referral eligibility bullets in second person and active v…
mintlify[bot] Aug 20, 2026
0a7631e
Merge remote-tracking branch 'origin/main' into mintlify/aa04a79a
mintlify[bot] Aug 20, 2026
2797101
docs: split compound sentences and name actor in hosted MCP server se…
mintlify[bot] Aug 20, 2026
83cbefd
Merge remote-tracking branch 'origin/main' into mintlify/aa04a79a
mintlify[bot] Aug 20, 2026
d4c682c
docs: split compound sentence and name actor in VolumeCache page
mintlify[bot] Aug 20, 2026
c29702b
Merge remote-tracking branch 'origin/main' into mintlify/aa04a79a
mintlify[bot] Aug 20, 2026
83b3aaa
docs: normalize inline Note and fix fragment in choose-a-pod MIG callout
mintlify[bot] Aug 20, 2026
fe65b5f
Merge remote-tracking branch 'origin/main' into mintlify/aa04a79a
mintlify[bot] Aug 20, 2026
dcfc3dc
docs: normalize em-dash joiners, bullet punctuation, and Serverless c…
mintlify[bot] Aug 20, 2026
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: 2 additions & 2 deletions accounts-billing/referrals.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---

Check warning on line 1 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L1

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

Check warning on line 1 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L1

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

Check warning on line 1 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L1

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

Check warning on line 1 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L1

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

Check warning on line 1 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L1

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

Check warning on line 1 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L1

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

Check warning on line 1 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L1

Try to keep the Automated Readability Index (9.63) below 8.
title: "Referral, affiliate, and creator programs"
sidebarTitle: "Referral programs"
description: "Earn additional revenue through Runpod's referral, affiliate, and creator programs. Review account, billing, and management details for Runpod."
---

Runpod offers three programs that help you earn additional revenue while helping us grow our community. Whether you're referring new users, creating popular templates, or driving significant traffic, there's a program that fits your contribution style.

Check warning on line 7 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L7

Try to avoid using first-person plural like 'us'.

Check warning on line 7 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L7

Try to avoid using first-person plural like 'our'.

## Runpod referral program

Expand All @@ -19,22 +19,22 @@
- **Bonus credits** for both you and your referral after they load \$10 on their account. The bonus amount depends on your location:
- **Non-European customers** receive a random weighted bonus between \$5 and \$500.
- **European customers** receive a fixed \$5 bonus.
- **Cross-region referrals**: If a European customer refers a non-European customer, the European customer receives \$5 and the non-European customer receives the random weighted bonus (\$5-\$500). If a non-European customer refers a European customer, the non-European customer receives the random weighted bonus and the European customer receives \$5.

Check warning on line 22 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L22

Use parentheses judiciously.

If you referred users before June 16, 2025, you're part of our beta program group. This means you'll continue earning commissions on their spend indefinitely, not just for 6 months.

Check warning on line 24 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L24

Try to avoid using first-person plural like 'our'.

### Eligibility requirements

For a referral to qualify for rewards, the person you refer must meet all of the following requirements:

- They must sign up using Google SSO. Referrals who sign up through any other method are not eligible for rewards.

Check warning on line 30 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L30

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

Check warning on line 30 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L30

Use 'aren't' instead of 'are not'.
- They must be a first-time Runpod user. Users who previously had a Runpod account under the same email address, including deleted accounts, are not eligible for referral rewards.
- They must be a first-time Runpod user. If they previously had a Runpod account under the same email address, including a deleted account, they are not eligible for referral rewards.

Check warning on line 31 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L31

Use 'they're' instead of 'they are'.
- They must have signed up after June 15, 2025. Accounts created before this date are not eligible.

Check warning on line 32 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L32

Use 'aren't' instead of 'are not'.
- They must load at least \$10 onto their account. The bonus credits are awarded only after this minimum \$10 load.
- They must load at least \$10 onto their account. Runpod awards the bonus credits only after they meet this minimum \$10 load.

## Runpod affiliate program

The affiliate program is designed for high-performing referrers who want to earn cash instead of credits. Through our partnership with Partnerstack, eligible referrers can earn 10% cash commissions on all referral spend.

Check warning on line 37 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L37

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

Check warning on line 37 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L37

Try to avoid using first-person plural like 'our'.

### Eligibility and rewards

Expand All @@ -46,7 +46,7 @@

Once you opt into the affiliate program, this decision is permanent. Choose carefully based on whether you prefer cash payments or Runpod Credits.

For beta program participants (users referred before June 26, 2025), a special arrangement applies. These users will be eligible for Partnerstack commissions during their first 6 months. After that period, they'll return to the standard referral program but continue generating commissions indefinitely.

Check warning on line 49 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L49

Use parentheses judiciously.

Check warning on line 49 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L49

Avoid using 'will'.

## Runpod creator program

Expand All @@ -67,21 +67,21 @@
Getting started with any of these programs is straightforward:

1. Navigate to your [referral dashboard](https://www.console.runpod.io/user/referrals) in the Runpod console.
2. Find your unique referral link (it will look something like `https://runpod.io?ref=5t99c9je`).

Check warning on line 70 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L70

Use parentheses judiciously.

Check warning on line 70 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L70

Avoid using 'will'.
3. Share this link with potential users through your preferred channels.

For the creator program, simply publish templates through your Runpod account and promote them to potential users.

## Important details

Understanding how these programs work will help you maximize your earnings:

Check warning on line 77 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L77

Avoid using 'will'.

1. **Referral commissions are based on actual usage, not purchases.** If someone you refer buys \$1,000 in credits, you won't earn commission until they actually use those credits on Pods or Serverless workloads.

Check warning on line 79 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L79

In general, use active voice instead of passive voice ('are based').
2. **New accounts only.** Referral links only work for brand new Runpod users. If someone already has an account, referring them won't generate commissions.
3. **Bonus credit distribution varies by location.** Non-European customers receive credits through a weighted random system between \$5 and \$500, while European customers receive a fixed \$5 bonus. For non-European customers, most will receive a bonus of \$5, with about 96% receiving \$10 or less.

Check warning on line 81 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L81

Avoid using 'will'.

## Support

Have questions about maximizing your earnings or need help with any of these programs? [Contact our support team](https://contact.runpod.io/hc/en-us/requests/new) for assistance.

Check warning on line 85 in accounts-billing/referrals.mdx

View check run for this annotation

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

accounts-billing/referrals.mdx#L85

Try to avoid using first-person plural like 'our'.

Remember, if you're transitioning to the affiliate program, you'll keep all earnings accumulated through the referral program before making the switch.
6 changes: 3 additions & 3 deletions api-reference-v2/migrate-from-v1.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---

Check warning on line 1 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L1

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

Check warning on line 1 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L1

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

Check warning on line 1 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L1

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

Check warning on line 1 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L1

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

Check warning on line 1 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L1

Try to keep the Flesch–Kincaid grade level (8.23) below 8.
title: "Migrate from API v1"
sidebarTitle: "Migrate from v1"
description: "Move your integrations from the Runpod REST API v1 to the v2 base URL, endpoints, and request and response shapes."

Check warning on line 4 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L4

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

The Runpod REST API v2 reorganizes resource paths, consolidates Pod lifecycle actions, and standardizes request and response shapes. This guide maps the v1 surface you know to its v2 equivalent so you can update your integrations with confidence.

Check warning on line 7 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L7

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

Read this guide if you have an existing integration built against the v1 API. REST API v1 is deprecated and will be retired on November 15, 2026. Migrate your integrations to v2 before that date.

Check warning on line 9 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L9

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

Check warning on line 9 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L9

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

Check warning on line 9 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L9

Avoid using 'will'.

Check warning on line 9 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L9

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

## What changed at a glance

Expand All @@ -14,7 +14,7 @@

- The OpenAPI schema also moves accordingly, from `https://rest.runpod.io/v1/openapi.json` to `https://api.runpod.io/v2/openapi.json`. Regenerate any client or tooling against the v2 schema.

- Authentication is unchanged. Continue to pass your [Runpod API key](/get-started/api-keys) as an HTTP Bearer token in the `Authorization: Bearer RUNPOD_API_KEY` header. You don't need to change key management or scopes to call v2.

Check warning on line 17 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L17

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

## Endpoint mapping

Expand All @@ -35,10 +35,10 @@
v2 generalizes path parameters: where v1 used resource-specific names such as `{podId}`, `{endpointId}`, `{networkVolumeId}`, `{templateId}`, and `{containerRegistryAuthId}`, v2 uses a single generic `{id}` parameter across resources.

<Warning>
Billing paths don't map by name. In v1, `/billing/endpoints` returns Serverless billing history; in v2, Serverless billing moves to `/v2/billing/serverless`. The v2 path `/v2/billing/endpoints` is a different, new resourcePublic Endpoint billing history — so update your Serverless billing calls to the new path rather than assuming the old one carries over.
Billing paths don't map by name. In v1, `/billing/endpoints` returns Serverless billing history; in v2, Serverless billing moves to `/v2/billing/serverless`. The v2 path `/v2/billing/endpoints` is a different, new resource: Public Endpoint billing history. Update your Serverless billing calls to the new path rather than assuming the old one carries over.
</Warning>

## Consolidated Pod lifecycle

Check warning on line 41 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L41

'Consolidated Pod lifecycle' should use sentence-style capitalization.

In v1, each Pod state change had its own endpoint: `POST /pods/{podId}/start`, `/stop`, `/reset`, and `/restart`. In v2, these collapse into a single [Pod state transition endpoint](/api-reference-v2/pods/trigger-a-pod-state-transition), `POST /v2/pods/{id}/action`, whose request body carries the desired action as `{"action":"start|stop|restart|terminate"}`. Deletion still uses [`DELETE /v2/pods/{id}`](/api-reference-v2/pods/terminate-a-pod).

Expand All @@ -46,7 +46,7 @@
The v1 `reset` operation has no v2 action equivalent. The v2 action enum is limited to `start`, `stop`, `restart`, and `terminate`.
</Note>

For in-place changes to a Pod, v2 replaces v1's `POST /pods/{podId}/update` with a standard [PATCH request](/api-reference-v2/pods/update-a-pod) to `PATCH /v2/pods/{id}`. Serverless follows the same pattern: v2 drops v1's `POST /endpoints/{id}/update` in-place variant in favor of `PATCH /v2/serverless/{id}`.

Check warning on line 49 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L49

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

The following example shows how stopping a Pod changes between versions.

Expand All @@ -72,17 +72,17 @@

## Request and response shape changes

The v2 request and response formats differ from v1. The most impactful changes are nested create bodies, wrapped list responses, and standardized error objects. Full field-by-field mapping is out of scope for this guide; see the linked reference pages for complete schemas.

Check warning on line 75 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L75

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

Check warning on line 75 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L75

Use semicolons judiciously.

### Nested create bodies

- In v1, create bodies are flat, with top-level fields such as `gpuCount`, `gpuTypeIds`, `imageName`, `containerDiskInGb`, `volumeInGb`, `env`, and `ports`. The v2 `CreatePodRequest` is nested: `name` and `image` are required, GPU settings live under `gpu: {id, count}`, CPU settings under `cpu`, and storage under `mounts`. The `cloud` field defaults to `SECURE`, and you must set exactly one of `gpu` or `cpu`. See [Create a Pod](/api-reference-v2/pods/create-a-pod) for the full request schema.

Check warning on line 79 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L79

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

Check warning on line 79 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L79

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

- Serverless endpoint creation changes more than its path. In v1, `EndpointCreateInput` requires a `templateId`. v2's `CreateEndpointRequest` still supports `templateId`: you can create an endpoint from a template ID, or provide the container details directly with `name`, `image`, and `gpu`. When you create from a template, `image` is optional because the template supplies it. Worker and scaling settings nest under `workers` and `scaling`, replacing v1's flat `workersMin`, `workersMax`, `scalerType`, and `idleTimeout`. See [Create a Serverless endpoint](/api-reference-v2/serverless/create-a-serverless-endpoint) for the full schema.

- Templates share the same container-field renames as Pods: v1's `imageName`, `containerDiskInGb`, `isPublic`, and `containerRegistryAuthId` become `image`, `disk`, `public`, and a nested `registry` in v2. See [Create a template](/api-reference-v2/templates/create-a-template).

- Network volume creation renames `dataCenterId` to `dataCenter` and adds an optional `type` field for selecting the storage tier (`STANDARD` or `HIGH_PERFORMANCE`). See [Create a network volume](/api-reference-v2/network-volumes/create-a-network-volume).

Check warning on line 85 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L85

Use parentheses judiciously.

### Wrapped list responses

Expand Down Expand Up @@ -110,11 +110,11 @@

The v2 wrapper key matches the resource: `GET /v2/pods` returns `{"pods":[...]}`, Serverless returns `{"endpoints":[...]}`, templates return `{"templates":[...]}`, network volumes return `{"networkVolumes":[...]}`, and registries return `{"registries":[...]}`. See [List Pods](/api-reference-v2/pods/list-pods) for a complete example.

### RFC 9457 error objects

Check warning on line 113 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L113

'RFC 9457 error objects' should use sentence-style capitalization.

Check warning on line 113 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L113

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

In v1, errors return a simple `{"message":"..."}` object. In v2, errors follow the RFC 9457 problem format with required `title`, `status`, and `detail` fields, plus an optional `errors` array of validation strings.

Check warning on line 115 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L115

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

As in v1, Runpod returns a `403` when a valid API key lacks access to the requested resource—but in v2 that response now uses the problem format shown here.
As in v1, Runpod returns a `403` when a valid API key lacks access to the requested resource. In v2, that response now uses the problem format shown here.

<CodeGroup>

Expand All @@ -136,7 +136,7 @@

## New in v2

- The v2 API adds capabilities that have no v1 equivalent.
The v2 API adds capabilities that have no v1 equivalent.

- Catalog endpoints let you browse available compute without provisioning it: `GET /v2/catalog/gpus` and `/gpus/{id}`, `/cpus` and `/cpus/{id}`, and `/datacenters` and `/datacenters/{id}`. See [List GPU types](/api-reference-v2/catalog/list-gpu-types).

Expand All @@ -144,7 +144,7 @@

- Serverless observability adds worker and release visibility through `GET /v2/serverless/{id}/workers`, `/workers/{workerId}/logs`, and `/releases`. See [List Serverless endpoint workers](/api-reference-v2/serverless/list-serverless-endpoint-workers), [Stream Serverless worker logs](/api-reference-v2/serverless/stream-serverless-worker-logs), and [List Serverless endpoint releases](/api-reference-v2/serverless/list-serverless-endpoint-releases).

- Registry ECR delegations manage delegated registry access with `GET` and `POST /v2/registries/delegations` and `DELETE /v2/registries/delegations/{id}`. These endpoints aren't yet covered by a dedicated reference page during beta; consult the [v2 OpenAPI schema](/api-reference-v2/overview) for their request and response formats.

Check warning on line 147 in api-reference-v2/migrate-from-v1.mdx

View check run for this annotation

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

api-reference-v2/migrate-from-v1.mdx#L147

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

- Expanded billing adds an aggregated history at `GET /v2/billing` alongside Serverless, Public Endpoint, and Instant Clusters histories, going beyond v1's Pods, endpoints, and network volume breakdowns. See [Get aggregated billing history](/api-reference-v2/billing/get-aggregated-billing-history).

Expand Down
2 changes: 1 addition & 1 deletion flash/apps/build-app.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---

Check warning on line 1 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L1

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

Check warning on line 1 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L1

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

Check warning on line 1 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L1

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

Check warning on line 1 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L1

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

Check warning on line 1 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L1

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

Check warning on line 1 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L1

Try to keep the SMOG grade (10.08) below 10.
title: "Build a Flash app"
sidebarTitle: "Build a Flash app"
description: "Create a Flash app, test it locally, and deploy it to production. Review setup, configuration, deployment, and usage guidance for Runpod Flash."
---

Flash apps let you build APIs to serve AI/ML workloads on Runpod Serverless. This guide walks you through the process of building a Flash app from scratch, from project initialization and local testing to production deployment.

Check warning on line 7 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L7

Use the Oxford comma in ', from project initialization and local testing to production deployment.'.

<Tip>
If you haven't already, we recommend starting with the [Quickstart](/flash/quickstart) guide to get a feel for how Flash `@Endpoint` functions work.
Expand All @@ -31,7 +31,7 @@
uv pip install runpod-flash
```

Use the `flash init` command to generate a structured project template with a preconfigured application entry point:

Check warning on line 34 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L34

Use 'app' instead of 'application'.

```bash
uv run flash init .
Expand All @@ -43,7 +43,7 @@
uv run flash login
```

This opens your browser to authorize Flash. After you approve, your credentials are saved for all Flash CLI commands.

Check warning on line 46 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L46

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

Check warning on line 46 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L46

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

## Step 2: Explore the project template

Expand Down Expand Up @@ -110,16 +110,16 @@
uv run flash dev --auto-provision
```

This eliminates cold-start delays by provisioning all serverless endpoints upfront. Endpoints are cached and reused across server restarts, making subsequent runs faster. Resources are identified by name, so the same endpoint won't be re-deployed if the configuration hasn't changed.

Check warning on line 113 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L113

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

Check warning on line 113 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L113

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

## Step 5: Open the API explorer

Check warning on line 115 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L115

Use 'APIs Explorer' instead of 'API explorer'.

Besides starting the API server, `flash dev` also starts an interactive API explorer. Point your web browser at [http://localhost:8888/docs](http://localhost:8888/docs) to explore the API.

Check warning on line 117 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L117

Use 'APIs Explorer' instead of 'API explorer'.

To run endpoint functions in the explorer:

1. Expand one of the functions under **GPU Workers** or **CPU Workers**.
2. Click **Try it out** and then **Execute**.
2. Select **Try it out**, then **Execute**.

You'll get a response from your workers right in the explorer.

Expand All @@ -127,14 +127,14 @@

To customize your endpoints:

1. Edit the `@Endpoint` functions in your worker files (`lb_worker.py`, `gpu_worker.py`, `cpu_worker.py`).

Check warning on line 130 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L130

Use parentheses judiciously.
2. Add new worker files for new endpoints.
3. Test individual workers by running them as scripts (e.g., `python gpu_worker.py`).

Check warning on line 132 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L132

Use parentheses judiciously.

Check warning on line 132 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L132

Use 'for example' instead of 'e.g.'.
4. Restart the development server to pick up changes.

### Example: Adding a custom GPU endpoint

Check warning on line 135 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L135

'Example: Adding a custom GPU endpoint' should use sentence-style capitalization.

To add a new GPU endpoint for image generation, create a new worker file or modify an existing one. For deployed apps, each queue-based function needs its own unique endpoint configuration:

Check warning on line 137 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L137

Use the Oxford comma in ', create a new worker file or modify an existing one.'.

```python
from runpod_flash import Endpoint, GpuType
Expand Down Expand Up @@ -165,9 +165,9 @@
return {"image": img_str, "prompt": prompt}
```

This creates a new Serverless endpoint specifically for image generation. When deployed, it will be available at its own endpoint URL with its own `/run` or `/runsync` routes.

Check warning on line 168 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L168

Avoid using 'will'.

## Step 7: Deploy to Runpod

Check warning on line 170 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L170

'Step 7: Deploy to Runpod' should use sentence-style capitalization.

When you're ready to deploy your app to Runpod, use `flash deploy`:

Expand All @@ -177,7 +177,7 @@

This command:

1. Builds your application into a deployment artifact.

Check warning on line 180 in flash/apps/build-app.mdx

View check run for this annotation

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

flash/apps/build-app.mdx#L180

Use 'app' instead of 'application'.
2. Uploads it to Runpod's storage.
3. Provisions independent Serverless endpoints for each endpoint configuration.
4. Configures service discovery for inter-endpoint communication.
Expand Down
6 changes: 3 additions & 3 deletions flash/cli/build.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---

Check warning on line 1 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L1

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

Check warning on line 1 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L1

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

Check warning on line 1 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L1

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

Check warning on line 1 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L1

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

Check warning on line 1 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L1

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

Check warning on line 1 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L1

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

Check warning on line 1 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L1

Try to keep the Flesch reading ease score (48.17) above 70.
title: "build"
sidebarTitle: "build"
---

Build a deployment-ready artifact for your Flash application without deploying. Use this for more control over the build process or to inspect the artifact before deploying.

Check warning on line 6 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L6

Use 'app' instead of 'application'.

```bash
flash build [OPTIONS]
Expand Down Expand Up @@ -49,17 +49,17 @@

## What happens during build

1. **Python version resolution**: Resolves the target Python version from CLI flag, resource configs, or your local interpreter.

Check warning on line 52 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L52

Use 'command-line tool' instead of 'CLI'.
2. **Function discovery**: Finds all `@Endpoint` decorated functions.
3. **Grouping**: Groups functions by their endpoint configuration.
4. **Manifest generation**: Creates `.flash/flash_manifest.json` with endpoint definitions.
5. **Source fingerprinting**: Computes a SHA-256 fingerprint of your source files to detect code changes between deployments.

Check warning on line 56 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L56

Spell out 'SHA', if it's unfamiliar to the audience.
6. **Dependency installation**: Installs Python packages for Linux x86_64.
7. **Packaging**: Bundles everything into `.flash/artifact.tar.gz`.

## Built-in ignore patterns

Flash automatically excludes certain files and directories from deployment artifacts. These patterns cover common development files that shouldn't be deployed to production.

Check warning on line 62 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L62

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

| Category | Patterns |
|----------|----------|
Expand All @@ -78,9 +78,9 @@

### Local modules and the ignore filter

Local (non-pip) modules that your endpoints import are bundled automatically, provided they pass the ignore filter: your `.gitignore` plus the built-in patterns listed above. During the build, Flash resolves the transitive local-import closure of every shipped Python file and checks it against the files the ignore filter already selected.

Check warning on line 81 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L81

Use parentheses judiciously.

Check warning on line 81 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L81

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

Check warning on line 81 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L81

Use 'preceding' instead of 'above'.

If shipped code imports a local module that an ignore rule excludes (for example, a `test_*.py` sibling or a file under `tests/`), the build fails with a `LocalModuleResolutionError` instead of silently overriding your ignore rules or shipping a broken artifact. Flash names each excluded file and the file that imports it:
If shipped code imports a local module that an ignore rule excludes (for example, a `test_*.py` sibling or a file under `tests/`), the build fails with a `LocalModuleResolutionError`. Failing early is deliberate: Flash won't silently override your ignore rules or ship a broken artifact. The error names each excluded file and the file that imports it:

Check warning on line 83 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L83

Use parentheses judiciously.

Check warning on line 83 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L83

'Flash' should be in lowercase.

```
Shipped code imports local modules that the build ignore rules (.gitignore or built-in defaults) exclude:
Expand All @@ -89,7 +89,7 @@
Shipping them would silently override a deliberate exclusion, and omitting them would break the worker with ModuleNotFoundError. Remove the matching ignore pattern or stop importing these modules from shipped code.
```

If an `@Endpoint` file has a local import Flash can't resolve at all (a broken relative import, or a file outside your project root), the build also fails with a clear error. A file that fails resolution but doesn't define an endpoint is skipped with a warning and the build continues. For details on how local imports are resolved and bundled, see [Import local modules](/flash/create-endpoints#import-local-modules).
If an `@Endpoint` file has a local import Flash can't resolve at all (for example, a broken relative import or a file outside your project root), the build fails with a clear error. If a file that doesn't define an endpoint fails resolution, Flash skips it with a warning and continues the build. For details on how local imports are resolved and bundled, see [Import local modules](/flash/create-endpoints#import-local-modules).

Check warning on line 92 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L92

Use parentheses judiciously.

Check warning on line 92 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L92

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

## Build artifacts

Expand All @@ -99,22 +99,22 @@
|----------------|-------------|
| `.flash/artifact.tar.gz` | Deployment package ready for Runpod |
| `.flash/flash_manifest.json` | Service discovery configuration |
| `.flash/.build/` | Build directory (kept for inspection) |

Check warning on line 102 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L102

Use parentheses judiciously.

## Cross-platform builds

Flash automatically handles cross-platform builds:

- **Automatic platform targeting**: Dependencies are installed for Linux x86_64, regardless of your build platform.

Check warning on line 108 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L108

In general, use active voice instead of passive voice ('are installed').
- **Binary wheel enforcement**: Only pre-built wheels are used, preventing compilation issues.

Check warning on line 109 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L109

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

### Python version in deployed workers

Flash workers support Python 3.10, 3.11, 3.12, and 3.13. The target version is determined by:

Check warning on line 113 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L113

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

1. **CLI flag:** The `--python-version` flag takes precedence.

Check warning on line 115 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L115

Use 'command-line tool' instead of 'CLI'.
2. **Resource config:** The `python_version` parameter on your endpoint configs.
3. **Local interpreter:** Your local Python version (from `sys.version_info`) when neither is specified.

Check warning on line 117 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L117

Use parentheses judiciously.

Check warning on line 117 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L117

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

All resources in a Flash app must use the same Python version because Flash ships a single tarball for the entire app. If resources declare conflicting versions, the build fails.

Expand All @@ -127,19 +127,19 @@
| 3.12 | No overhead | PyTorch pre-installed in base image |
| 3.13 | +~7 GB on GPU | Alternative Python install required |
| 3.11 | +~7 GB on GPU | Alternative Python install required |
| 3.10 | +~7 GB on GPU | EOL 2026-10-31; consider migrating to 3.11+ |

Check warning on line 130 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L130

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

Check warning on line 130 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L130

Use semicolons judiciously.

If your local Python version is not supported (for example, 3.9 or 3.14), the build fails with an actionable error message listing the supported versions.

Check warning on line 132 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L132

Use 'isn't' instead of 'is not'.

Check warning on line 132 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L132

Use parentheses judiciously.

Image tags follow the pattern `py{version}-{tag}` (for example, `runpod/flash:py3.12-latest`).

Check warning on line 134 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L134

Use parentheses judiciously.

## Managing deployment size

Runpod Serverless has a **1.5GB deployment limit**. Flash automatically excludes packages that are pre-installed in the base image:

Check warning on line 138 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L138

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

- `torch`, `torchvision`, `torchaudio`, `triton`

These packages are excluded at archive time, so you don't need to specify them manually.

Check warning on line 142 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L142

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

### Manual exclusions

Expand Down Expand Up @@ -179,7 +179,7 @@

### Archive is too large

Some CUDA packages (`torch`, `torchvision`, `torchaudio`, `triton`) are auto-excluded. If the archive is still too large, use `--exclude` to skip additional packages or `--no-deps` to skip transitive dependencies:

Check warning on line 182 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L182

Use parentheses judiciously.

Check warning on line 182 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L182

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

```bash
flash build --exclude scipy,pandas
Expand All @@ -189,12 +189,12 @@

If a package doesn't have Linux x86_64 wheels:

1. Ensure standard pip is installed: `python -m ensurepip --upgrade`

Check warning on line 192 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L192

In general, use active voice instead of passive voice ('is installed').
2. Check PyPI for Linux wheel availability.

### Need to examine generated files

The build directory is kept after building. Inspect it with:

Check warning on line 197 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L197

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

```bash
ls .flash/.build/
Expand All @@ -202,12 +202,12 @@

## Related commands

- [`flash deploy`](/flash/cli/deploy) - Build and deploy in one step (includes `--preview` option for local testing)

Check warning on line 205 in flash/cli/build.mdx

View check run for this annotation

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

flash/cli/build.mdx#L205

Use parentheses judiciously.
- [`flash dev`](/flash/cli/dev) - Start development server
- [`flash env`](/flash/cli/env) - Manage environments

<Note>

Most users should use `flash deploy` instead, which runs build and deploy in one step. Use `flash build` when you need more control or want to inspect the artifact.
In most cases, use `flash deploy` instead, which runs build and deploy in one step. Use `flash build` when you need more control or want to inspect the artifact.

</Note>
6 changes: 3 additions & 3 deletions flash/create-endpoints.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---

Check warning on line 1 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L1

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

Check warning on line 1 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L1

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

Check warning on line 1 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L1

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

Check warning on line 1 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L1

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

Check warning on line 1 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L1

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

Check warning on line 1 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L1

Try to keep the SMOG grade (10.36) below 10.
title: "Create endpoints"
sidebarTitle: "Create endpoints"
description: "Learn how to create and configure hardware and scaling behavior with the Flash Endpoint class. Review configuration and usage details for Runpod Flash."
Expand All @@ -22,7 +22,7 @@
return {"result": "processed"}
```

When you call `run_model(data)`, Flash provisions a GPU <WorkerTooltip /> on Runpod (or reuses an existing one), sends your function code and input to the worker, executes it, and returns the result to your local environment.

Check warning on line 25 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L25

Use parentheses judiciously.

Each unique endpoint `name` creates one Serverless endpoint on Runpod with its own URL, scaling configuration, and hardware allocation. The endpoint manages workers that scale up and down based on demand.

Expand Down Expand Up @@ -81,13 +81,13 @@
```

Load-balanced endpoints are ideal for:
- REST APIs with multiple routes

Check warning on line 84 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L84

Spell out 'REST', if it's unfamiliar to the audience.
- Low-latency request/response patterns
- Services requiring custom HTTP methods

### Custom Docker images

Deploy pre-built Docker images (like vLLM or your own workers) and interact with them as a client:

Check warning on line 90 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L90

Use parentheses judiciously.

```python
from runpod_flash import Endpoint, GpuType
Expand All @@ -103,7 +103,7 @@
models = await vllm.get("/v1/models")
```

See [Custom Docker images](/flash/custom-docker-images) for complete documentation, including available images and configuration options.

Check warning on line 106 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L106

Use the Oxford comma in ', including available images and configuration options.'.

### Existing endpoints

Expand All @@ -123,11 +123,11 @@
result = await ep.post("/v1/completions", {"prompt": "hello"})
```

## GPU vs CPU

Check warning on line 126 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L126

'GPU vs CPU' should use sentence-style capitalization.

Specify `gpu=` for GPU endpoints or `cpu=` for CPU endpoints. They are mutually exclusive.

Check warning on line 128 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L128

Use 'they're' instead of 'They are'.

### GPU endpoints

Check warning on line 130 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L130

'GPU endpoints' should use sentence-style capitalization.

```python
from runpod_flash import Endpoint, GpuType, GpuGroup
Expand All @@ -145,9 +145,9 @@
async def process(data: dict) -> dict: ...
```

If neither `gpu=` nor `cpu=` is specified, GPU defaults to `GpuGroup.ANY`.

Check warning on line 148 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L148

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

### CPU endpoints

Check warning on line 150 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L150

'CPU endpoints' should use sentence-style capitalization.

```python
from runpod_flash import Endpoint, CpuInstanceType
Expand Down Expand Up @@ -206,7 +206,7 @@

### Import packages inside the function body

You must import pip/installed packages **inside the decorated function body**, not at the top of your file. This ensures imports happen on the remote worker. This rule applies to installed packages only; local project modules can be imported at the top of the file because Flash ships their source (see [Import local modules](#import-local-modules)).

Check warning on line 209 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L209

Use parentheses judiciously.

Check warning on line 209 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L209

Use semicolons judiciously.

Check warning on line 209 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L209

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

**Correct:** imports inside the function.
```python
Expand All @@ -227,7 +227,7 @@

### System dependencies

Use `system_dependencies` to install system-level packages (via apt):

Check warning on line 230 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L230

Use parentheses judiciously.

```python
@Endpoint(
Expand All @@ -244,21 +244,21 @@

## Import local modules

Your endpoint can import local (non-pip) Python modules that live alongside it in your project, such as a sibling `utils.py` file or a `helpers/` package. Flash detects these imports, follows them transitively, and ships the module source to the worker for you, so an import like `import utils` or `from helpers import load` works remotely with no extra configuration.
Your endpoint can import local (non-pip) Python modules that live alongside it in your project, such as a sibling `utils.py` file or a `helpers/` package. Flash detects these imports, follows them transitively, and ships the module source to the worker for you. Imports like `import utils` or `from helpers import load` work remotely with no extra configuration.

Check warning on line 247 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L247

Use parentheses judiciously.

Flash resolves local imports whether they appear at the top of the file or inside the function body, and it supports absolute imports (`import utils`), relative imports (`from . import helpers`), and dynamic imports with a literal name (`importlib.import_module("plugin")`). It also pulls in the `__init__.py` files for any packages you import. Flash can't resolve dynamic imports whose module name is computed at runtime, so it emits a warning, and you're responsible for making those modules available on the worker.

Check warning on line 249 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L249

Use parentheses judiciously.

Check warning on line 249 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L249

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

Flash bundles only local project files. Standard library modules are already present in the worker image, and pip packages must still be declared through the `dependencies` parameter. This applies transitively: if a bundled local module imports a pip package at its top level, that package must still be declared in the `dependencies` of any endpoint that uses the module.
Flash bundles only local project files. Standard library modules are already present in the worker image, and pip packages must still be declared through the `dependencies` parameter. This applies transitively. If a bundled local module imports a pip package at its top level, declare that package in the `dependencies` of any endpoint that uses the module.

Check warning on line 251 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L251

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

On `flash build` and `flash deploy`, local modules are bundled when they pass the ignore filter, and importing a local module that an ignore rule excludes (or one Flash can't resolve) fails the build. See [Local modules and the ignore filter](/flash/cli/build#local-modules-and-the-ignore-filter) for details.
On `flash build` and `flash deploy`, Flash bundles local modules that pass the ignore filter. Importing a local module that an ignore rule excludes (or one Flash can't resolve) fails the build. See [Local modules and the ignore filter](/flash/cli/build#local-modules-and-the-ignore-filter) for details.

Check warning on line 253 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L253

Use parentheses judiciously.

### Live execution size limit

When you run an endpoint live (calling an `@Endpoint` function directly, or during `flash dev`), Flash ships the resolved module source inline with the request. The combined source is capped at 8 MiB. If your local dependencies exceed this limit, deploy the app with `flash deploy` instead, which bundles local modules into the build artifact rather than the request payload. See [Local module payload too large](/flash/troubleshooting#local-module-payload-too-large) for the corresponding error.

Check warning on line 257 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L257

Use parentheses judiciously.

Check warning on line 257 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L257

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

### Local modules in a parent directory

On the live execution path, Flash treats a module imported by absolute name from a parent directory as external and doesn't ship it, which causes a `ModuleNotFoundError` on the worker. For example, this happens with `import shared` when `shared.py` sits above your endpoint file. To avoid it, place your endpoint at or above its local dependencies, or use `flash deploy`, which resolves imports against the whole project directory.

Check warning on line 261 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L261

Use 'preceding' instead of 'above'.

Check warning on line 261 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L261

Use 'preceding' instead of 'above'.

## Parallel execution

Expand Down Expand Up @@ -312,7 +312,7 @@

## Persistent storage

Attach a network volume for persistent storage across workers. Each volume is tied to a specific datacenter. Flash uses the volume `name` to find an existing volume or create a new one:

Check warning on line 315 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L315

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

```python
from runpod_flash import Endpoint, GpuGroup, DataCenter, NetworkVolume
Expand All @@ -330,7 +330,7 @@
...
```

For multi-datacenter deployments, pass a list of volumes (one per datacenter):

Check warning on line 333 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L333

Use parentheses judiciously.

```python
from runpod_flash import Endpoint, GpuGroup, DataCenter, NetworkVolume
Expand All @@ -356,7 +356,7 @@

For a complete list of parameters available for the `Endpoint` class, see [Endpoint parameters](/flash/configuration/parameters).

## Working with jobs (client mode)

Check warning on line 359 in flash/create-endpoints.mdx

View check run for this annotation

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

flash/create-endpoints.mdx#L359

Use parentheses judiciously.

When using `Endpoint(id=...)` or `Endpoint(image=...)`, you get an `EndpointJob` object for async operations:

Expand Down
4 changes: 2 additions & 2 deletions flash/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---

Check warning on line 1 in flash/overview.mdx

View check run for this annotation

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

flash/overview.mdx#L1

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

Check warning on line 1 in flash/overview.mdx

View check run for this annotation

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

flash/overview.mdx#L1

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

Check warning on line 1 in flash/overview.mdx

View check run for this annotation

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

flash/overview.mdx#L1

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

Check warning on line 1 in flash/overview.mdx

View check run for this annotation

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

flash/overview.mdx#L1

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

Check warning on line 1 in flash/overview.mdx

View check run for this annotation

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

flash/overview.mdx#L1

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

Check warning on line 1 in flash/overview.mdx

View check run for this annotation

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

flash/overview.mdx#L1

Try to keep the SMOG grade (10.38) below 10.
title: "Overview"
sidebarTitle: "Overview"
description: "Build autoscaling AI/ML apps using local code with Runpod Flash. Review setup, configuration, deployment, and usage guidance for Runpod Flash."
Expand Down Expand Up @@ -47,10 +47,10 @@
Flash requires a Runpod account with a verified email address.
</Note>

### Install Flash

Check warning on line 50 in flash/overview.mdx

View check run for this annotation

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

flash/overview.mdx#L50

'Install Flash' should use sentence-style capitalization.

<Note>
Flash requires [Python 3.10, 3.11, 3.12, or 3.13](https://www.python.org/downloads/) and runs natively on macOS and Linux. Windows users can run Flash through [WSL2](/flash/windows-wsl2).
Flash requires [Python 3.10, 3.11, 3.12, or 3.13](https://www.python.org/downloads/) and runs natively on macOS and Linux. On Windows, run Flash through [WSL2](/flash/windows-wsl2).
</Note>

Install Flash using `pip` or `uv`:
Expand All @@ -74,9 +74,9 @@
uv run flash login
```

This saves your API key securely and allows you to use the Flash CLI and run `@Endpoint` functions.

Check warning on line 77 in flash/overview.mdx

View check run for this annotation

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

flash/overview.mdx#L77

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

### Coding agent integration (optional)

Check warning on line 79 in flash/overview.mdx

View check run for this annotation

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

flash/overview.mdx#L79

Use parentheses judiciously.

Install the Flash skill package for AI coding agents like Claude Code, Cline, and Cursor:

Expand All @@ -88,24 +88,24 @@

## Flash apps

When you're ready to move beyond scripts and build a production-ready API, you can create a [Flash app](/flash/apps/overview) (a collection of interconnected endpoints with diverse hardware configurations) and deploy it to Runpod.

Check warning on line 91 in flash/overview.mdx

View check run for this annotation

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

flash/overview.mdx#L91

Use parentheses judiciously.

[Follow this tutorial to build your first Flash app](/flash/apps/build-app).

## Flash CLI

Check warning on line 95 in flash/overview.mdx

View check run for this annotation

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

flash/overview.mdx#L95

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

The Flash CLI provides a set of commands for managing your Flash apps and endpoints.

Check warning on line 97 in flash/overview.mdx

View check run for this annotation

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

flash/overview.mdx#L97

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

```bash
flash --help
```

[Learn more about the Flash CLI](/flash/cli/overview).

Check warning on line 103 in flash/overview.mdx

View check run for this annotation

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

flash/overview.mdx#L103

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

## Limitations

- Flash runs natively on macOS and Linux. Windows users can run Flash through [WSL2](/flash/windows-wsl2).
- Flash runs natively on macOS and Linux. On Windows, run Flash through [WSL2](/flash/windows-wsl2).
- CPU endpoints are restricted to the `EU-RO-1` datacenter. GPU endpoints can deploy to [multiple datacenters](/flash/configuration/parameters#datacenter).

Check warning on line 108 in flash/overview.mdx

View check run for this annotation

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

flash/overview.mdx#L108

In general, use active voice instead of passive voice ('are restricted').
- Flash can rapidly scale workers across multiple endpoints, and you may hit your maximum worker threshold quickly. Contact [Runpod support](https://www.runpod.io/contact) to increase your account's capacity if needed.

## Tutorials
Expand Down
2 changes: 1 addition & 1 deletion flash/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---

Check warning on line 1 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L1

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

Check warning on line 1 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L1

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

Check warning on line 1 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L1

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

Check warning on line 1 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L1

Try to keep the LIX score (38.33) below 35.
title: "Get started with Flash"
sidebarTitle: "Quickstart"
description: "Run your first GPU workload with Flash in less than 5 minutes. Review setup, configuration, deployment, and usage guidance for Runpod Flash."
Expand All @@ -13,10 +13,10 @@
- [Python 3.10, 3.11, 3.12, or 3.13](https://www.python.org/downloads/) installed.
- [uv](https://docs.astral.sh/uv/) installed.

## Step 1: Install Flash

Check warning on line 16 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L16

'Step 1: Install Flash' should use sentence-style capitalization.

<Note>
Flash runs natively on macOS and Linux. Windows users can run Flash through [WSL2](/flash/windows-wsl2).
Flash runs natively on macOS and Linux. On Windows, run Flash through [WSL2](/flash/windows-wsl2).
</Note>

Create a virtual environment and install Flash using [uv](https://docs.astral.sh/uv/):
Expand All @@ -43,7 +43,7 @@

This enables your coding agent to provide more accurate Flash code suggestions and troubleshooting help.

## Step 2: Authenticate with Runpod

Check warning on line 46 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L46

'Step 2: Authenticate with Runpod' should use sentence-style capitalization.

Log in to your Runpod account:

Expand All @@ -54,7 +54,7 @@
uv run flash login
```

This opens your browser to authorize Flash. After you approve, your credentials are saved, allowing you to run Flash commands and scripts.

Check warning on line 57 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L57

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

<Tip>
Alternatively, you can set the `RUNPOD_API_KEY` environment variable or add it to a `.env` file. See [`flash login`](/flash/cli/login) for details.
Expand Down Expand Up @@ -113,7 +113,7 @@
Make sure you activate your virtual environment in the same directory where you created the `gpu_demo.py` file. If you open a new terminal, run `source .venv/bin/activate` before executing the script.
</Warning>

## Step 4: Run it

Check warning on line 116 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L116

'Step 4: Run it' should use sentence-style capitalization.

Execute the script:

Expand All @@ -137,7 +137,7 @@
✓ GPU used: NVIDIA RTX A5000
```

The first run takes 30-60 seconds, while Runpod provisions the endpoint, installs dependencies, and starts a worker. Subsequent runs take 2-3 seconds (because the worker is already running).

Check warning on line 140 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L140

Use parentheses judiciously.


<Tip>
Expand Down Expand Up @@ -172,7 +172,7 @@

## Step 6: Understand what you just did

Let's break down the code you just ran:

Check warning on line 175 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L175

Try to avoid using first-person plural like 'Let's'.

### Imports and setup

Expand All @@ -181,7 +181,7 @@
from runpod_flash import Endpoint, GpuGroup
```

- **`asyncio`**: Enables asynchronous execution (endpoint functions run async).

Check warning on line 184 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L184

Use parentheses judiciously.
- **`Endpoint`**: The class that marks functions for remote execution.
- **`GpuGroup`**: Enum for selecting GPU types or groups of GPUs.

Expand Down Expand Up @@ -221,12 +221,12 @@
The `@Endpoint` decorator configures everything in one place:

- **`name`**: Identifies your endpoint in the [Runpod console](https://console.runpod.io/serverless).
- **`gpu`**: Which GPU to use (`GpuGroup.ANY` accepts any available GPU for faster provisioning).

Check warning on line 224 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L224

Use parentheses judiciously.
- **`workers`**: Maximum parallel workers (allows 3 concurrent executions).

Check warning on line 225 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L225

Use parentheses judiciously.
- **`idle_timeout`**: Seconds a worker stays active after completing a request before scaling down. Setting this to 300 (5 minutes) gives you more time to iterate on your code while the worker remains warm.

Check warning on line 226 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L226

Use parentheses judiciously.
- **`dependencies`**: Python packages to install on the worker.
- **Function body**: The matrix multiplication code runs on the remote GPU, not your local machine.
- **Return value**: The result is returned to your local machine as a Python dictionary.

Check warning on line 229 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L229

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

See [GPU types](/flash/configuration/gpu-types) for available GPUs or [endpoint functions](/flash/create-endpoints) for all configuration options.

Expand Down Expand Up @@ -256,9 +256,9 @@
- If no: It creates a new endpoint, initializes a worker, and installs your dependencies.
2. Flash sends your code to the GPU worker
3. The GPU worker executes the function with the provided inputs.
4. The result is returned to your local machine as a Python dictionary, where it's printed in your terminal.

Check warning on line 259 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L259

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

Everything outside the `@Endpoint` function (all the `print` statements, etc.) runs **locally on your machine**. Only the decorated function runs remotely.

Check warning on line 261 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L261

Use parentheses judiciously.

## Step 7: Run multiple operations in parallel

Expand Down Expand Up @@ -334,7 +334,7 @@

## Next steps

You've successfully run GPU code on Runpod! Now you're ready to learn more about Flash:

Check warning on line 337 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L337

Don't use exclamation points in text.

<CardGroup cols={2}>
<Card title="Generate images with Flash" href="/tutorials/flash/image-generation-with-sdxl" icon="image" horizontal>
Expand All @@ -359,7 +359,7 @@
Error: API key is not set
```

**Solution**: Run `flash login` to authenticate with your Runpod account:

Check warning on line 362 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L362

'Run' should be in lowercase.

```bash
flash login
Expand All @@ -380,7 +380,7 @@
Error: endpoint template names must be unique
```

**Solution**: Each endpoint needs a unique `name`. If you've deployed an endpoint before with the same name, either:

Check warning on line 383 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L383

'Each' should be in lowercase.
- Use a different name for your new endpoint
- Undeploy the existing endpoint with `flash undeploy <name> --force`

Expand All @@ -391,7 +391,7 @@
[Stays in queue for >60 seconds]
```

**Solution**: No GPUs available. Use `GpuGroup.ANY` to accept any available GPU:

Check warning on line 394 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L394

'No' should be in lowercase.

```python
@Endpoint(
Expand Down Expand Up @@ -427,7 +427,7 @@
ModuleNotFoundError: No module named 'numpy'
```

**Solution**: Move imports inside the `@Endpoint` function:

Check warning on line 430 in flash/quickstart.mdx

View check run for this annotation

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

flash/quickstart.mdx#L430

'Move' should be in lowercase.

```python
@Endpoint(name="compute", gpu=GpuGroup.ANY, dependencies=["numpy"])
Expand Down
4 changes: 2 additions & 2 deletions flash/troubleshooting.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---

Check warning on line 1 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L1

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

Check warning on line 1 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L1

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

Check warning on line 1 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L1

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

Check warning on line 1 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L1

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

Check warning on line 1 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L1

Try to keep the LIX score (40.99) below 35.
title: "Troubleshooting"
sidebarTitle: "Troubleshooting"
description: "Monitor, debug, and troubleshoot Flash deployments. Review setup, configuration, deployment, and usage guidance for Runpod Flash."
Expand All @@ -10,7 +10,7 @@

### Viewing logs

When running Flash functions, logs are displayed in your terminal:

Check warning on line 13 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L13

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

```text
2025-11-19 12:35:15,109 | INFO | Created endpoint: rb50waqznmn2kg - flash-quickstart
Expand All @@ -35,7 +35,7 @@
View detailed metrics and logs in the [Runpod console](https://console.runpod.io/serverless):

1. Navigate to the **Serverless** section.
2. Click on your endpoint to view:
2. Select your endpoint to view:
- Active workers and queue depth.
- Request history and job status.
- Worker logs and execution details.
Expand All @@ -48,9 +48,9 @@

1. Go to the [Serverless console](https://console.runpod.io/serverless).
2. Select your endpoint.
3. Click on a worker to view its logs.
3. Select a worker to view its logs.

Logs include dependency installation output, function execution output (print statements, errors), and system-level messages.

Check warning on line 53 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L53

Use parentheses judiciously.

### Add logging to functions

Expand Down Expand Up @@ -84,7 +84,7 @@
Get a key: https://docs.runpod.io/get-started/api-keys
```

**Cause:** Flash requires a valid Runpod API key to provision and manage endpoints.

Check warning on line 87 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L87

'Flash' should be in lowercase.

**Solution:**

Expand All @@ -92,18 +92,18 @@

2. Authenticate using one of these methods:

**Option 1: Use `flash login` (recommended)**

Check warning on line 95 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L95

'Use' should be in lowercase.

Check warning on line 95 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L95

Use parentheses judiciously.
```bash
flash login
```
Opens your browser for authentication and saves your credentials.

**Option 2: Environment variable**

Check warning on line 101 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L101

'Environment' should be in lowercase.
```bash
export RUNPOD_API_KEY="your_api_key"
```

**Option 3: .env file for local CLI use**

Check warning on line 106 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L106

Use 'command-line tool' instead of 'CLI'.
```bash
echo "RUNPOD_API_KEY=your_api_key" >> .env
```
Expand All @@ -112,7 +112,7 @@
Values in your `.env` file are only available locally for CLI commands. They are not passed to deployed endpoints.
</Note>

**Option 4: Shell profile for persistent local access**

Check warning on line 115 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L115

'Shell' should be in lowercase.
```bash
echo 'export RUNPOD_API_KEY="your_api_key"' >> ~/.bashrc
source ~/.bashrc
Expand All @@ -126,9 +126,9 @@
Run 'flash login' to re-authenticate, or delete the file and retry.
```

**Cause:** The credentials file at `~/.runpod/config.toml` contains invalid TOML and cannot be read. This can also appear as "No API key found" even after a successful `flash login`.

Check warning on line 129 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L129

'The' should be in lowercase.

Check warning on line 129 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L129

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

Check warning on line 129 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L129

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

Check warning on line 129 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L129

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

**Solution:** Delete the credentials file and re-authenticate:

Check warning on line 131 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L131

'Delete' should be in lowercase.

```bash
rm ~/.runpod/config.toml
Expand All @@ -142,9 +142,9 @@
Load-balanced endpoints require route decorators
```

**Cause:** Load-balanced endpoints require HTTP method decorators for each route.

Check warning on line 145 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L145

'Load' should be in lowercase.

**Solution:** Ensure all routes use the correct decorator pattern:

Check warning on line 147 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L147

'Ensure' should be in lowercase.

```python
from runpod_flash import Endpoint
Expand All @@ -161,16 +161,16 @@
return {"status": "healthy"}
```

### Invalid HTTP method

Check warning on line 164 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L164

'Invalid HTTP method' should use sentence-style capitalization.

**Error:**
```
method must be one of {'GET', 'POST', 'PUT', 'DELETE', 'PATCH'}
```

**Cause:** The HTTP method specified is not supported.

Check warning on line 171 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L171

'The' should be in lowercase.

Check warning on line 171 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L171

Use 'isn't' instead of 'is not'.

**Solution:** Use one of the supported HTTP methods: `GET`, `POST`, `PUT`, `DELETE`, or `PATCH`.

Check warning on line 173 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L173

'Use' should be in lowercase.

### Invalid path format

Expand All @@ -179,9 +179,9 @@
path must start with '/'
```

**Cause:** HTTP paths must begin with a forward slash.

Check warning on line 182 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L182

'HTTP' should be in lowercase.

**Solution:** Ensure paths start with `/`:

Check warning on line 184 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L184

'Ensure' should be in lowercase.

```python
# Correct
Expand All @@ -198,13 +198,13 @@
Duplicate route 'POST /process' in endpoint 'my-api'
```

**Cause:** Two functions define the same HTTP method and path combination.

Check warning on line 201 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L201

'Two' should be in lowercase.

**Solution:** Ensure each route is unique within an endpoint. Either change the path or method of one function.

Check warning on line 203 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L203

'Ensure' should be in lowercase.

## Build errors

### Unsupported Python version

Check warning on line 207 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L207

'Unsupported Python version' should use sentence-style capitalization.

**Error:**
```
Expand All @@ -212,13 +212,13 @@
Pass --python-version, declare python_version on a resource config, or run flash from a supported interpreter.
```

**Cause:** Flash supports Python 3.10, 3.11, 3.12, and 3.13. Your local Python version is outside this range.

Check warning on line 215 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L215

'Flash' should be in lowercase.

**Solution:**

You have three options:

1. **Use the `--python-version` CLI flag** to override local detection:

Check warning on line 221 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L221

Use 'command-line tool' instead of 'CLI'.
```bash
flash build --python-version 3.12
flash deploy --python-version 3.12
Expand All @@ -244,7 +244,7 @@
Python 3.12 is recommended for best performance with no cold-start overhead. Python 3.10, 3.11, and 3.13 incur additional cold-start overhead on GPU workers because an alternative Python interpreter must be installed.
</Tip>

### Local module could not be resolved

Check warning on line 247 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L247

Use 'couldn't' instead of 'could not'.

Check warning on line 247 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L247

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

**Error:**
```
Expand All @@ -260,7 +260,7 @@
Shipping them would silently override a deliberate exclusion, and omitting them would break the worker with ModuleNotFoundError. Remove the matching ignore pattern or stop importing these modules from shipped code.
```

**Cause:** This `LocalModuleResolutionError` has two variants: an `@Endpoint` file imports a local module that Flash can't resolve, or shipped code imports a local module that an ignore pattern excludes.

Check warning on line 263 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L263

'This' should be in lowercase.

**Solution:**

Expand All @@ -283,11 +283,11 @@
Tarball exceeds maximum size. File size: 1.6GB, Max: 1.5GB
```

**Cause:** The deployment package exceeds the 1.5GB limit.

Check warning on line 286 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L286

'The' should be in lowercase.

Check warning on line 286 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L286

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

**Solution:**

1. Check for large files that shouldn't be included (datasets, model weights, logs).

Check warning on line 290 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L290

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

Check warning on line 290 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L290

Use parentheses judiciously.
2. Add large files to `.gitignore` to exclude them from the build.
3. Use [network volumes](/flash/configuration/storage) to store large models instead of bundling them.

Expand All @@ -298,25 +298,25 @@
File is not a valid gzip file. Expected magic bytes (31, 139)
```

**Cause:** The build artifact is corrupted or not a valid gzip file.

Check warning on line 301 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L301

'The' should be in lowercase.

Check warning on line 301 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L301

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

**Solution:** Delete the `.flash` directory and rebuild:

Check warning on line 303 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L303

'Delete' should be in lowercase.

```bash
rm -rf .flash
flash build
```

### SSL certificate verification failed

Check warning on line 310 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L310

'SSL certificate verification failed' should use sentence-style capitalization.

**Error:**
```
SSL certificate verification failed. This usually means Python cannot find your system's CA certificates.
```

**Cause:** Python cannot locate the system's trusted CA certificates, preventing secure connections during deployment. This commonly occurs on fresh Python installations, especially on macOS.

Check warning on line 317 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L317

'Python' should be in lowercase.

Check warning on line 317 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L317

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

**Solution:** Try one of these fixes:

Check warning on line 319 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L319

'Try' should be in lowercase.

1. **Install certifi and set the certificate bundle path:**
```bash
Expand All @@ -324,7 +324,7 @@
export REQUESTS_CA_BUNDLE=$(python -c "import certifi; print(certifi.where())")
```

2. **macOS only:** Run the certificate installer that comes with Python. Find it in your Python installation folder (typically `/Applications/Python 3.x/`) and run `Install Certificates.command`.

Check warning on line 327 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L327

Use parentheses judiciously.

3. **Add to shell profile for persistence:**
```bash
Expand All @@ -343,7 +343,7 @@
Failed to provision resources: [error details]
```

**Cause:** Flash couldn't create the Serverless endpoint on Runpod.

Check warning on line 346 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L346

'Flash' should be in lowercase.

**Solutions:**

Expand All @@ -365,7 +365,7 @@
Endpoint URL not available - endpoint may not be deployed
```

**Cause:** The endpoint function was called before the endpoint finished provisioning.

Check warning on line 368 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L368

'The' should be in lowercase.

Check warning on line 368 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L368

In general, use active voice instead of passive voice ('was called').

**Solutions:**

Expand All @@ -382,7 +382,7 @@
Execution timeout on [endpoint] after [N]s
```

**Cause:** The endpoint function took longer than the configured timeout.

Check warning on line 385 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L385

'The' should be in lowercase.

**Solutions:**

Expand All @@ -397,7 +397,7 @@

2. **Optimize function**: Profile your function to identify bottlenecks.

3. **Use queue-based endpoints**: For long-running tasks, use the `@Endpoint` decorator pattern. Queue-based endpoints are designed for longer operations.

Check warning on line 400 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L400

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

### Connection failed

Expand All @@ -406,7 +406,7 @@
Failed to connect to endpoint [name] ([url])
```

**Cause:** Network connectivity issue between your local environment and the Runpod endpoint.

Check warning on line 409 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L409

'Network' should be in lowercase.

**Solutions:**

Expand All @@ -414,14 +414,14 @@
2. **Retry**: Transient network issues often resolve on retry. Flash includes automatic retry logic.
3. **Check endpoint status**: Verify the endpoint is running in the [Serverless console](https://console.runpod.io/serverless).

### HTTP errors from endpoint

Check warning on line 417 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L417

'HTTP errors from endpoint' should use sentence-style capitalization.

**Error:**
```
HTTP error from endpoint [name]: 500 - Internal Server Error
```

**Cause:** The endpoint function raised an exception during execution.

Check warning on line 424 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L424

'The' should be in lowercase.

**Solutions:**

Expand All @@ -447,7 +447,7 @@
Failed to deserialize result: [error]
```

**Cause:** The function's return value cannot be serialized/deserialized.

Check warning on line 450 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L450

'The' should be in lowercase.

Check warning on line 450 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L450

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

Check warning on line 450 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L450

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

**Solutions:**

Expand All @@ -471,11 +471,11 @@
Payload size X MB exceeds limit of 10.0 MB
```

**Cause:** The serialized argument exceeds the 10 MB limit. Flash uses base64 encoding, which expands data by approximately 33%, so roughly 7.5 MB of raw data becomes 10 MB when encoded.

Check warning on line 474 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L474

'The' should be in lowercase.

**Solutions:**

1. **Use network volumes for large data**: Save large data to a network volume and pass the file path:

Check warning on line 478 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L478

Use 'path' instead of 'file path'.
```python
@Endpoint(name="processor", gpu=GpuGroup.ANY, volume="vol_abc123")
async def process(file_path: str) -> dict:
Expand All @@ -484,7 +484,7 @@
return {"result": process_data(data)}
```

2. **Compress data before sending**: For data that must be passed directly, use compression:

Check warning on line 487 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L487

In general, use active voice instead of passive voice ('be passed').
```python
import gzip

Expand All @@ -502,9 +502,9 @@
Use `flash deploy` for endpoints with large local dependencies.
```

**Cause:** On the live execution path (calling an `@Endpoint` function directly or during `flash dev`), Flash ships your local module source inline with the request, and the combined source exceeds the 8 MiB cap.

Check warning on line 505 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L505

Use parentheses judiciously.

Check warning on line 505 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L505

'On' should be in lowercase.

**Solution:** Deploy the app with `flash deploy`, which bundles local modules into the build artifact instead of the request payload:

Check warning on line 507 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L507

'Deploy' should be in lowercase.

```bash
flash deploy
Expand All @@ -513,7 +513,7 @@
uv run flash deploy
```

See [Live execution size limit](/flash/create-endpoints#live-execution-size-limit) for details on how local module source is shipped.

Check warning on line 516 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L516

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

### Deserialization timeout

Expand All @@ -522,9 +522,9 @@
Deserialization timed out after 30s
```

**Cause:** The deserialization process took longer than 30 seconds. This usually indicates malformed or corrupted serialized data that causes the unpickle operation to hang.

Check warning on line 525 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L525

'The' should be in lowercase.

**Solution:** Verify your input data is properly serialized. If you're manually constructing payloads, ensure the data was serialized using `cloudpickle` and encoded with base64. The Flash SDK handles this automatically for programmatic calls.

Check warning on line 527 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L527

'Verify' should be in lowercase.

Check warning on line 527 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L527

In general, use active voice instead of passive voice ('was serialized').

### Circuit breaker open

Expand All @@ -533,23 +533,23 @@
Circuit breaker is open. Retry in [N] seconds
```

**Cause:** Too many consecutive failures to the endpoint triggered the circuit breaker protection.

Check warning on line 536 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L536

'Too' should be in lowercase.

**Solutions:**

1. **Wait and retry**: The circuit breaker will automatically attempt recovery after the timeout (typically 60 seconds).

Check warning on line 540 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L540

Avoid using 'will'.

Check warning on line 540 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L540

Use parentheses judiciously.

2. **Check endpoint health**: Multiple failures usually indicate an underlying issue. Check logs and endpoint status.

3. **Fix the root cause**: Address whatever is causing the repeated failures before retrying.

## GPU availability issues

Check warning on line 546 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L546

'GPU availability issues' should use sentence-style capitalization.

### Job stuck in queue

**Symptom:** Job status shows `IN_QUEUE` for extended periods.

Check warning on line 550 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L550

'Job' should be in lowercase.

**Cause:** The requested GPU types are not available.

Check warning on line 552 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L552

'The' should be in lowercase.

Check warning on line 552 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L552

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

**Solutions:**

Expand All @@ -565,7 +565,7 @@
)
```

2. **Use GpuGroup.ANY**: For development, accept any available GPU:

Check warning on line 568 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L568

'p.A' should have one space.

Check warning on line 568 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L568

Spell out 'ANY', if it's unfamiliar to the audience.
```python
gpu=GpuGroup.ANY
```
Expand All @@ -578,14 +578,14 @@

### Module not found

**Error (in worker logs):**

Check warning on line 581 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L581

Use parentheses judiciously.
```
ModuleNotFoundError: No module named 'transformers'
```

**Cause:** A required dependency was not specified in the `@Endpoint` decorator.

Check warning on line 586 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L586

Use 'wasn't' instead of 'was not'.

**Solution:** Add all required packages to the `dependencies` parameter:

Check warning on line 588 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L588

'Add' should be in lowercase.

```python
@Endpoint(
Expand All @@ -600,11 +600,11 @@

### Version conflicts

**Symptom:** Function fails with import errors or unexpected behavior.

Check warning on line 603 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L603

'Function' should be in lowercase.

**Cause:** Dependency version conflicts between packages.

Check warning on line 605 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L605

'Dependency' should be in lowercase.

**Solution:** Pin specific versions:

Check warning on line 607 in flash/troubleshooting.mdx

View check run for this annotation

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

flash/troubleshooting.mdx#L607

'Pin' should be in lowercase.

```python
@Endpoint(
Expand Down
6 changes: 3 additions & 3 deletions get-started/mcp-servers.mdx
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
---

Check warning on line 1 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L1

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

Check warning on line 1 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L1

Try to keep the Flesch reading ease score (62.79) above 70.
title: "Use Runpod's MCP servers"

Check warning on line 2 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L2

Spell out 'MCP', if it's unfamiliar to the audience.
sidebarTitle: "MCP servers"
description: "Connect AI tools to Runpod using the Model Context Protocol for infrastructure management and documentation access."
tag: "NEW"

Check warning on line 5 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L5

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

Runpod provides two [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro) servers that connect AI tools and coding agents directly to Runpod:

- **[Runpod API MCP server](#runpod-api-mcp-server):** Manage Pods, endpoints, templates, volumes, and registries through the Runpod REST API. Authenticate with Sign in with Runpod or a [Runpod API key](/get-started/api-keys).

Check warning on line 10 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L10

Spell out 'REST', if it's unfamiliar to the audience.
- **[Runpod docs MCP server](#runpod-docs-mcp-server):** Search Runpod documentation for features, code examples, and guides. No authentication required.

## Runpod API MCP server

Check warning on line 13 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L13

'Runpod API MCP server' should use sentence-style capitalization.

The Runpod API MCP server gives AI tools access to the [Runpod REST API](/api-reference/overview), letting you create and manage Pods, Serverless endpoints, templates, network volumes, and container registries through natural language.

Check warning on line 15 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L15

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

**Hosted endpoint:** `https://mcp.getrunpod.io/` (Streamable HTTP transport)

Check warning on line 17 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L17

Use parentheses judiciously.

**Local package:** `@runpod/mcp-server` (via npx)

Check warning on line 19 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L19

Use parentheses judiciously.

**Source code:** [github.com/runpod/runpod-mcp](https://github.com/runpod/runpod-mcp)

**Authentication:** Sign in with Runpod (OAuth) for the hosted server, or a [Runpod API key](/get-started/api-keys) for the local server or as a hosted-server override.

Check warning on line 23 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L23

'Sign' should be in lowercase.

Check warning on line 23 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L23

Use parentheses judiciously.

Check warning on line 23 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L23

Use 'OAuth 2.0' instead of 'OAuth'.

You can connect in two ways: the recommended hosted server, or a local server that runs from an npm package with an API key.

### Hosted server (recommended)

Check warning on line 27 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L27

Use parentheses judiciously.

The hosted server runs at `https://mcp.getrunpod.io/` and provides the same capabilities as the local server. OAuth-capable clients run a "Sign in with Runpod" flow on first connect: a browser opens, you log in to the Runpod console and approve the request, and the server obtains a session-scoped API key. Nothing is stored on disk.
The hosted server runs at `https://mcp.getrunpod.io/` and provides the same capabilities as the local server. OAuth-capable clients run a "Sign in with Runpod" flow on first connect. A browser opens, you log in to the Runpod console and approve the request, and the server obtains a session-scoped API key. The server stores nothing on disk.

Check warning on line 29 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L29

Use 'OAuth 2.0' instead of 'OAuth'.

The guided installer is the recommended path for supported clients. It detects your installed clients — Claude Code, Claude Desktop, Cursor, Windsurf, and VS Code — and configures each one, handling client-specific config-key differences automatically:

Check warning on line 31 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L31

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

Check warning on line 31 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L31

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

```bash
npx @runpod/mcp-server@latest add
Expand All @@ -36,26 +36,26 @@

To undo these changes, run `npx @runpod/mcp-server@latest remove`.

#### Claude Code (hosted)

Check warning on line 39 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L39

'Claude Code (hosted)' should use sentence-style capitalization.

Check warning on line 39 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L39

Use parentheses judiciously.

```bash
claude mcp add --transport http runpod -s user https://mcp.getrunpod.io/
```

#### Claude Desktop (hosted)

Check warning on line 45 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L45

'Claude Desktop (hosted)' should use sentence-style capitalization.

Check warning on line 45 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L45

Use parentheses judiciously.

1. Open **Settings** in Claude Desktop.
2. Navigate to **Connectors** and select **Add custom connector**.
3. Enter `https://mcp.getrunpod.io/` as the URL and click **Add**.

#### VS Code with Copilot (hosted)

Check warning on line 51 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L51

'VS Code with Copilot (hosted)' should use sentence-style capitalization.

Check warning on line 51 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L51

Use parentheses judiciously.

1. Open the Command Palette (Ctrl+Shift+P on Windows/Linux or Cmd+Shift+P on macOS).

Check warning on line 53 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L53

Use parentheses judiciously.
2. Run **MCP: Add Server** and select **HTTP**.
3. Enter `https://mcp.getrunpod.io/` as the URL and `Runpod` as the name.
4. Select **Global** or **Workspace** and click **Add**.

#### Other clients (hosted)

Check warning on line 58 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L58

Use parentheses judiciously.

For any other MCP-compatible client, use the remote URL `https://mcp.getrunpod.io/`:

Expand All @@ -69,7 +69,7 @@
}
```

Clients differ in the exact key name they use for a remote server URL. For the clients the guided installer supports, it writes the correct configuration automatically; for any other client, consult that client's MCP documentation for how to add a remote HTTP server, using the URL above.
Clients differ in the exact key name they use for a remote server URL. For the clients the guided installer supports, it writes the correct configuration automatically. For any other client, consult that client's MCP documentation for how to add a remote HTTP server, using the URL above.

Check warning on line 72 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L72

Use 'preceding' instead of 'above'.

<Note>
To skip the OAuth flow, pass your API key as a bearer header. For example, in Claude Code:
Expand All @@ -82,22 +82,22 @@
Clients configured with JSON use a `headers` block instead.
</Note>

### Local server (API key)

Check warning on line 85 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L85

Use parentheses judiciously.

Use this method to run the server locally with an API key stored in your client config — for example, if your client doesn't support the hosted server's sign-in flow, or you prefer to manage the credential yourself.
Use this method to run the server locally with an API key stored in your client config. For example, choose this method if your client doesn't support the hosted server's sign-in flow, or if you prefer to manage the credential yourself.

#### Supported clients

- [Claude Code](#claude-code)
- [Codex CLI](#codex-cli)

Check warning on line 92 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L92

Use 'command-line tool' instead of 'CLI'.
- [Cursor](#cursor)
- [VS Code with Copilot](#vs-code-with-copilot)
- [Claude Desktop](#claude-desktop)
- [Windsurf](#windsurf)
- [Cline](#cline)
- [Gemini CLI](#gemini-cli)

Check warning on line 98 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L98

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

#### Claude Code

Check warning on line 100 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L100

'Claude Code' should use sentence-style capitalization.

```bash
claude mcp add runpod --scope user -e RUNPOD_API_KEY=your_api_key_here -- npx -y @runpod/mcp-server@latest
Expand All @@ -105,9 +105,9 @@

Replace `your_api_key_here` with your Runpod API key. The `--scope user` flag makes the server available across all your projects. Run `/mcp` inside Claude Code to verify the connection.

#### Codex CLI

Check warning on line 108 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L108

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

[Codex CLI](https://github.com/openai/codex) is OpenAI's terminal-based coding agent.

Check warning on line 110 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L110

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

```bash
codex mcp add runpod --env RUNPOD_API_KEY=your_api_key_here -- npx -y @runpod/mcp-server@latest
Expand All @@ -115,7 +115,7 @@

#### Cursor

Add the following to `.cursor/mcp.json` (project-level) or `~/.cursor/mcp.json` (global). This configuration works with both the Cursor IDE and the [Cursor Agent](https://cursor.com/docs/cli/mcp):

Check warning on line 118 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L118

Use parentheses judiciously.

Check warning on line 118 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L118

Use parentheses judiciously.

```json
{
Expand All @@ -131,9 +131,9 @@
}
```

#### VS Code with Copilot

Check warning on line 134 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L134

'VS Code with Copilot' should use sentence-style capitalization.

1. Open the Command Palette (Ctrl+Shift+P on Windows/Linux or Cmd+Shift+P on macOS).

Check warning on line 136 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L136

Use parentheses judiciously.
2. Run **MCP: Add Server** and select **stdio**.
3. Enter the following details:
- **Name:** `Runpod`
Expand All @@ -142,7 +142,7 @@
4. Add environment variable `RUNPOD_API_KEY` with your Runpod API key.
5. Select **Global** or **Workspace** and click **Add**.

#### Claude Desktop

Check warning on line 145 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L145

'Claude Desktop' should use sentence-style capitalization.

Add the following to your Claude Desktop config file:

Expand All @@ -167,7 +167,7 @@

#### Windsurf

Edit `~/.codeium/windsurf/mcp_config.json` (or open from **Settings** > **Cascade** > **MCP Servers** > **View raw config**):

Check warning on line 170 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L170

Use parentheses judiciously.

```json
{
Expand Down Expand Up @@ -202,9 +202,9 @@
}
```

#### Gemini CLI

Check warning on line 205 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L205

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

Add to `~/.gemini/settings.json` (global) or `.gemini/settings.json` (project-level):

Check warning on line 207 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L207

Use parentheses judiciously.

Check warning on line 207 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L207

Use parentheses judiciously.

```json
{
Expand Down Expand Up @@ -257,21 +257,21 @@
Stop the Pod named "ml-training-pod"
```

## Runpod docs MCP server

Check warning on line 260 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L260

'Runpod docs MCP server' should use sentence-style capitalization.

The Runpod docs MCP server provides access to Runpod's documentation knowledge base, making it easier to get answers about features and how to use them.

**Endpoint:** `https://docs.runpod.io/mcp`

**Authentication:** None required

Check warning on line 266 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L266

'None' should be in lowercase.

### Claude Code

Check warning on line 268 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L268

'Claude Code' should use sentence-style capitalization.

```bash
claude mcp add runpod-docs --scope user --transport http https://docs.runpod.io/mcp
```

### Codex CLI

Check warning on line 274 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L274

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

```bash
codex mcp add runpod-docs --url https://docs.runpod.io/mcp
Expand All @@ -291,14 +291,14 @@
}
```

### VS Code with Copilot

Check warning on line 294 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L294

'VS Code with Copilot' should use sentence-style capitalization.

1. Open the Command Palette (Ctrl+Shift+P on Windows/Linux or Cmd+Shift+P on macOS).

Check warning on line 296 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L296

Use parentheses judiciously.
2. Run **MCP: Add Server** and select **HTTP**.
3. Enter `https://docs.runpod.io/mcp` as the URL and `Runpod Docs` as the name.
4. Select **Global** or **Workspace** and click **Add**.

### Claude Desktop

Check warning on line 301 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L301

'Claude Desktop' should use sentence-style capitalization.

1. Open **Settings** in Claude Desktop.
2. Navigate to **Connectors** and select **Add custom connector**.
Expand Down Expand Up @@ -333,9 +333,9 @@
}
```

### Gemini CLI

Check warning on line 336 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L336

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

Add to `~/.gemini/settings.json`. Note that Gemini CLI uses `httpUrl` instead of `url`:

Check warning on line 338 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L338

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

```json
{
Expand All @@ -349,7 +349,7 @@

### Other clients

For any other MCP-compatible client, use URL `https://docs.runpod.io/mcp` (HTTP transport).

Check warning on line 352 in get-started/mcp-servers.mdx

View check run for this annotation

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

get-started/mcp-servers.mdx#L352

Use parentheses judiciously.

### Usage examples

Expand Down
Loading
Loading