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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions api-reference/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---

Check warning on line 1 in api-reference/overview.mdx

View check run for this annotation

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

api-reference/overview.mdx#L1

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

Check warning on line 1 in api-reference/overview.mdx

View check run for this annotation

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

api-reference/overview.mdx#L1

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

Check warning on line 1 in api-reference/overview.mdx

View check run for this annotation

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

api-reference/overview.mdx#L1

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

Check warning on line 1 in api-reference/overview.mdx

View check run for this annotation

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

api-reference/overview.mdx#L1

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

Check warning on line 1 in api-reference/overview.mdx

View check run for this annotation

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

api-reference/overview.mdx#L1

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

Check warning on line 1 in api-reference/overview.mdx

View check run for this annotation

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

api-reference/overview.mdx#L1

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

Check warning on line 1 in api-reference/overview.mdx

View check run for this annotation

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

api-reference/overview.mdx#L1

Try to keep the Flesch reading ease score (20.17) above 70.
title: "Overview"
sidebarTitle: "Overview"
description: "Use the Runpod API to programmatically manage your compute resources. Review authentication, request formats, and response details for the Runpod API."
---

The Runpod REST API v1 provides programmatic access to all Runpod compute resources. Integrate GPU infrastructure into your applications, workflows, and automation systems.

Check warning on line 7 in api-reference/overview.mdx

View check run for this annotation

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

api-reference/overview.mdx#L7

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

<Warning>
REST API v1 is deprecated and will be retired on **November 15, 2026**. Migrate your integrations to REST API v2 before that date. See the [migration guide](/api-reference-v2/migrate-from-v1) to get started. To migrate automatically, ask your coding agent to run `/runpod:migrate rest` once you've installed the [Runpod skills plugin](/get-started/agent-skills#migrate-an-existing-integration).
Expand All @@ -27,6 +27,8 @@

Retrieve the complete OpenAPI specification for client generation, request validation, or tooling integration.

See the [interactive API documentation endpoint reference](/api-reference/docs/GET/docs) to open the browser-based reference directly.

<CodeGroup>

```bash cURL
Expand Down
2 changes: 1 addition & 1 deletion community-solutions/copyparty-file-manager/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---

Check warning on line 1 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L1

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

Check warning on line 1 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L1

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

Check warning on line 1 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L1

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

Check warning on line 1 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L1

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

Check warning on line 1 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L1

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

Check warning on line 1 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L1

Try to keep the Flesch–Kincaid grade level (8.09) below 8.
title: CopyParty file manager
description: "Web-based GUI for easy file browsing, uploading, downloading, and media viewing on Runpod. Review setup and usage guidance for this Runpod community solution."
icon: "party-horn"
---

# Setting up CopyParty on Runpod
## Set up CopyParty on Runpod

Check warning on line 7 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L7

'Set up CopyParty on Runpod' should use sentence-style capitalization.

CopyParty provides a webbased GUI that makes file management simple on Runpod instances. With its intuitive interface, you can browse directories, upload/download files, preview images and videos, and manage your Pod's filesystem without complex command-line operations.

## About CopyParty

Check warning on line 11 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L11

'About CopyParty' should use sentence-style capitalization.

CopyParty is an open-source project created that provides a portable file server with a web UI. It's perfect for managing files on cloud GPU instances where traditional file transfer methods might be cumbersome.

Check warning on line 13 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L13

Use 'open source' instead of 'open-source'.

For a video demonstration, you can watch the [creator's YouTube tutorial](https://www.youtube.com/watch?v=15_-hgsX2V0).

Expand All @@ -33,22 +33,22 @@

You can access the terminal in two ways:

#### Option 1: Web terminal

Check warning on line 36 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L36

'Option 1: Web terminal' should use sentence-style capitalization.
If you see this option when clicking "Connect" on your Pod page, you have web terminal access:
![Web Terminal Access](/community-solutions/copyparty-file-manager/webterminal.png)

#### Option 2: JupyterLab terminal

Check warning on line 40 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L40

'Option 2: JupyterLab terminal' should use sentence-style capitalization.
If you have JupyterLab installed on your Pod, you can access the terminal there:
![JupyterLab Terminal](/community-solutions/copyparty-file-manager/labsterminal.png)

## Installation steps

### Step 1: Access your Pod settings

Check warning on line 46 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L46

'Step 1: Access your Pod settings' should use sentence-style capitalization.

Navigate to your Pod page and locate the settings:
![Edit Pod Settings](/community-solutions/copyparty-file-manager/edit.png)

### Step 2: Add an HTTP port

Check warning on line 51 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L51

'Step 2: Add an HTTP port' should use sentence-style capitalization.

<Warning>
**Adding a new port will restart your Pod and erase any data not stored in `/workspace`**
Expand All @@ -56,16 +56,16 @@
Before proceeding, ensure all important files are saved in `/workspace` or backed up elsewhere. Any installed libraries or files outside of `/workspace` will be lost.
</Warning>

Add a dedicated HTTP port for the CopyParty interface. If port 8888 is already in use (common for Jupyter), try port 8000 or another available port.

Check warning on line 59 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L59

Use parentheses judiciously.

![Add HTTP Port](/community-solutions/copyparty-file-manager/addhttp.png)

### Step 3: Install and run CopyParty

Open your terminal (web terminal or Jupyter terminal) and run one of the following commands:

Check warning on line 65 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L65

Use parentheses judiciously.

#### Option 1: Standard installation

Check warning on line 67 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L67

'Option 1: Standard installation' should use sentence-style capitalization.
Run CopyParty directly (the session will end if you close the terminal):

Check warning on line 68 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L68

Use parentheses judiciously.

Check warning on line 68 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L68

Avoid using 'will'.

```bash
curl -LsSf https://astral.sh/uv/install.sh | sh && source $HOME/.local/bin/env && uv tool run copyparty -p 8000 --allow-csrf
Expand All @@ -90,7 +90,7 @@
</Info>

This command:
1. Installs tmux (a terminal multiplexer)

Check warning on line 93 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L93

Use parentheses judiciously.
2. Creates a new tmux session named "copyparty"
3. Runs CopyParty in the background
4. Attaches you to the session to see the output
Expand All @@ -102,12 +102,12 @@
- To stop CopyParty: Reattach and press `Ctrl+C`
</Tip>

### Step 4: Access the CopyParty interface

Check warning on line 105 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L105

'Step 4: Access the CopyParty interface' should use sentence-style capitalization.

Once CopyParty is running, click on the port number in your Runpod dashboard:

Check warning on line 107 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L107

Use 'click' or 'click in' instead of 'click on'.
![Access Port](/community-solutions/copyparty-file-manager/port.png)

## Using CopyParty

Check warning on line 110 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L110

'Using CopyParty' should use sentence-style capitalization.

### File navigation

Expand All @@ -122,7 +122,7 @@
### Downloading files

To download files:
1. Click on files to select them (they'll be highlighted in pink)

Check warning on line 125 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L125

Use 'click' or 'click in' instead of 'Click on'.

Check warning on line 125 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L125

Use parentheses judiciously.

Check warning on line 125 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L125

In general, use active voice instead of passive voice ('be highlighted').
2. Use the buttons in the bottom right:
- **"dl"** - Download individual files
- **"zip"** - Download multiple files as a zip archive
Expand All @@ -132,20 +132,20 @@
## Tips and best practices

1. **Data Persistence**: Always store important files in `/workspace` to survive pod restarts
2. **Port Selection**: Choose a port that doesn't conflict with other services (avoid 8888 if using Jupyter)

Check warning on line 135 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L135

Use parentheses judiciously.
3. **Large Files**: CopyParty handles large file transfers well, making it ideal for model weights and datasets

## Troubleshooting

### Session ends when terminal closes
Use the tmux option (Option 2) to keep CopyParty running in the background

Check warning on line 141 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L141

Use parentheses judiciously.

## Alternative file transfer methods

While CopyParty provides an excellent web-based solution, Runpod also supports:
- Direct SSH/SCP transfers (if SSH is enabled)

Check warning on line 146 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L146

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

Check warning on line 146 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L146

Use parentheses judiciously.

Check warning on line 146 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L146

In general, use active voice instead of passive voice ('is enabled').
- JupyterLab file browser
- [Runpod CLI](/runpodctl/overview) tool

Check warning on line 148 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L148

Use 'command-line tool' instead of 'CLI'.
- [Cloud storage integration](/pods/storage/cloud-sync) (S3, Google Drive, etc.)

Check warning on line 149 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L149

Use 'Google Cloud Platform' or 'GCP' instead of 'Cloud'.

Check warning on line 149 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L149

Use parentheses judiciously.

Choose the method that best fits your workflow and security requirements.

Check warning on line 151 in community-solutions/copyparty-file-manager/overview.mdx

View check run for this annotation

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

community-solutions/copyparty-file-manager/overview.mdx#L151

Avoid the unverifiable claim 'best'.
2 changes: 1 addition & 1 deletion community-solutions/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---

Check warning on line 1 in community-solutions/overview.mdx

View check run for this annotation

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

community-solutions/overview.mdx#L1

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

Check warning on line 1 in community-solutions/overview.mdx

View check run for this annotation

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

community-solutions/overview.mdx#L1

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

Check warning on line 1 in community-solutions/overview.mdx

View check run for this annotation

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

community-solutions/overview.mdx#L1

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

Check warning on line 1 in community-solutions/overview.mdx

View check run for this annotation

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

community-solutions/overview.mdx#L1

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

Check warning on line 1 in community-solutions/overview.mdx

View check run for this annotation

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

community-solutions/overview.mdx#L1

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

Check warning on line 1 in community-solutions/overview.mdx

View check run for this annotation

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

community-solutions/overview.mdx#L1

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

Check warning on line 1 in community-solutions/overview.mdx

View check run for this annotation

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

community-solutions/overview.mdx#L1

Try to keep the LIX score (48.85) below 35.
title: "Introduction"
title: "Community solutions"
description: "Community-created tools and solutions by and for Runpod users. Review setup and usage guidance for this Runpod community solution."
icon: "flask"
---

This section showcases innovative tools and solutions created by the Runpod community. These are tools and workflows developed by users who encountered common challenges and built creative solutions to share with others.

While these tools and solutions are not officially maintained by Runpod, we highlight them here because they demonstrate the ingenuity of our community and can be valuable resources for users facing similar challenges.

Check warning on line 9 in community-solutions/overview.mdx

View check run for this annotation

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

community-solutions/overview.mdx#L9

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

Check warning on line 9 in community-solutions/overview.mdx

View check run for this annotation

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

community-solutions/overview.mdx#L9

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

Check warning on line 9 in community-solutions/overview.mdx

View check run for this annotation

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

community-solutions/overview.mdx#L9

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

## Using community solutions

Community tools and solutions are provided as-is and maintained by their creators. While we showcase them for their utility, please note that you should test in a development environment first, review the source code when available, report issues to the tool creators, and ultimately use them at your own discretion.

Check warning on line 13 in community-solutions/overview.mdx

View check run for this annotation

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

community-solutions/overview.mdx#L13

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

Check warning on line 13 in community-solutions/overview.mdx

View check run for this annotation

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

community-solutions/overview.mdx#L13

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

## Featured tools & solutions

Expand Down Expand Up @@ -50,8 +50,8 @@
</Card>
</CardGroup>

Browse through our community tools section in the sidebar for detailed documentation on each tool's purpose, installation, and usage.

Check warning on line 53 in community-solutions/overview.mdx

View check run for this annotation

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

community-solutions/overview.mdx#L53

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

## Contributing

Built something useful on Runpod? The community would love to learn about it! Share your tools and get feedback in the [Runpod Discord](https://discord.com/invite/runpod).

Check warning on line 57 in community-solutions/overview.mdx

View check run for this annotation

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

community-solutions/overview.mdx#L57

Don't use exclamation points in text.
6 changes: 6 additions & 0 deletions get-started/connect-to-runpod.mdx
Original file line number Diff line number Diff line change
@@ -1,40 +1,46 @@
---

Check warning on line 1 in get-started/connect-to-runpod.mdx

View check run for this annotation

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

get-started/connect-to-runpod.mdx#L1

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

Check warning on line 1 in get-started/connect-to-runpod.mdx

View check run for this annotation

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

get-started/connect-to-runpod.mdx#L1

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

Check warning on line 1 in get-started/connect-to-runpod.mdx

View check run for this annotation

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

get-started/connect-to-runpod.mdx#L1

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

Check warning on line 1 in get-started/connect-to-runpod.mdx

View check run for this annotation

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

get-started/connect-to-runpod.mdx#L1

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

Check warning on line 1 in get-started/connect-to-runpod.mdx

View check run for this annotation

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

get-started/connect-to-runpod.mdx#L1

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

Check warning on line 1 in get-started/connect-to-runpod.mdx

View check run for this annotation

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

get-started/connect-to-runpod.mdx#L1

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

Check warning on line 1 in get-started/connect-to-runpod.mdx

View check run for this annotation

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

get-started/connect-to-runpod.mdx#L1

Try to keep the SMOG grade (12.27) below 10.
title: "Choose a workflow"
description: "Review available methods for accessing and managing Runpod resources. Review setup steps and core concepts for building on Runpod."
---

import { PodsTooltip, EndpointTooltip, ServerlessTooltip } from "/snippets/tooltips.jsx";

Runpod offers multiple ways to access and manage your compute resources. Choose the method that best fits your workflow:

Check warning on line 8 in get-started/connect-to-runpod.mdx

View check run for this annotation

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

get-started/connect-to-runpod.mdx#L8

Avoid the unverifiable claim 'best'.

If you are deciding between Pods, Serverless, Public Endpoints, and Clusters, start with the [Runpod product overview](/get-started/products).

## Runpod console

The Runpod console provides an intuitive web interface to manage <PodsTooltip /> and <EndpointTooltip />s, access Pod terminals, send endpoint requests, monitor resource usage, and view billing and usage history.

[Launch the Runpod console →](https://www.console.runpod.io)

## Connect directly to Pods

Check warning on line 18 in get-started/connect-to-runpod.mdx

View check run for this annotation

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

get-started/connect-to-runpod.mdx#L18

'Connect directly to Pods' should use sentence-style capitalization.

You can connect directly to your running Pods and execute code on them using a variety of methods, including a built-in web terminal, an SSH connection from your local machine, a JupyterLab instance, or a remote VSCode/Cursor development environment.

[Learn more about Pod connection options →](/pods/connect-to-a-pod)

## REST API

Check warning on line 24 in get-started/connect-to-runpod.mdx

View check run for this annotation

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

get-started/connect-to-runpod.mdx#L24

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

Check warning on line 24 in get-started/connect-to-runpod.mdx

View check run for this annotation

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

get-started/connect-to-runpod.mdx#L24

'REST API' should use sentence-style capitalization.

The Runpod REST API allows you to programmatically manage and control compute resources. Use the API to manage Pod lifecycles and <ServerlessTooltip /> endpoints, monitor resource utilization, and integrate Runpod into your applications.

Check warning on line 26 in get-started/connect-to-runpod.mdx

View check run for this annotation

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

get-started/connect-to-runpod.mdx#L26

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

[Explore the API reference →](/api-reference/docs/GET/openapi-json)

## SDKs

Check warning on line 30 in get-started/connect-to-runpod.mdx

View check run for this annotation

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

get-started/connect-to-runpod.mdx#L30

'SDKs' should use sentence-style capitalization.

Runpod provides SDKs in Python, JavaScript, Go, and GraphQL to help you integrate Runpod services into your applications.

[Explore the SDKs →](/serverless/sdks)

## Command-line interface (CLI)

Check warning on line 36 in get-started/connect-to-runpod.mdx

View check run for this annotation

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

get-started/connect-to-runpod.mdx#L36

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

The Runpod CLI allows you to manage Pods from your terminal, execute code on Pods, transfer data between Runpod and local systems, and programmatically manage Serverless endpoints.

Check warning on line 38 in get-started/connect-to-runpod.mdx

View check run for this annotation

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

get-started/connect-to-runpod.mdx#L38

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

Every Pod comes pre-installed with the `runpodctl` command and includes a Pod-scoped API key for seamless command-line management.

[Learn more about runpodctl →](/runpodctl/overview)

## Coding agents

Use the [agent onboarding guide](/agent-setup) to install Runpod skills and connect the Runpod MCP server to a supported coding agent.

Check warning on line 46 in get-started/connect-to-runpod.mdx

View check run for this annotation

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

get-started/connect-to-runpod.mdx#L46

Spell out 'MCP', if it's unfamiliar to the audience.
3 changes: 3 additions & 0 deletions instant-clusters.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---

Check warning on line 1 in instant-clusters.mdx

View check run for this annotation

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

instant-clusters.mdx#L1

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

Check warning on line 1 in instant-clusters.mdx

View check run for this annotation

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

instant-clusters.mdx#L1

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

Check warning on line 1 in instant-clusters.mdx

View check run for this annotation

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

instant-clusters.mdx#L1

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

Check warning on line 1 in instant-clusters.mdx

View check run for this annotation

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

instant-clusters.mdx#L1

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

Check warning on line 1 in instant-clusters.mdx

View check run for this annotation

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

instant-clusters.mdx#L1

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

Check warning on line 1 in instant-clusters.mdx

View check run for this annotation

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

instant-clusters.mdx#L1

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

Check warning on line 1 in instant-clusters.mdx

View check run for this annotation

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

instant-clusters.mdx#L1

Try to keep the Automated Readability Index (10.07) below 8.
title: "Overview"
sidebarTitle: "Overview"
description: "Fully managed compute clusters for multi-node training and AI inference. Review configuration and operations guidance for Runpod Clusters."
Expand Down Expand Up @@ -28,11 +28,14 @@
<Card title="Axolotl fine-tuning" href="/instant-clusters/axolotl" icon="screwdriver" horizontal>
Fine-tune LLMs across multiple GPUs.
</Card>
<Card title="Distributed inference with Ray and vLLM" href="/instant-clusters/ray-vllm" icon="network-wired" horizontal>
Serve models across multiple nodes with Ray and vLLM.
</Card>
</CardGroup>

## How it works

Runpod provisions multiple GPU nodes in the same <DataCenterTooltip /> connected with high-speed networking. One node is designated primary (`NODE_RANK=0`), and all nodes receive pre-configured environment variables for distributed communication.

Check warning on line 38 in instant-clusters.mdx

View check run for this annotation

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

instant-clusters.mdx#L38

Use parentheses judiciously.

Check warning on line 38 in instant-clusters.mdx

View check run for this annotation

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

instant-clusters.mdx#L38

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

<div style={{ marginLeft: '4rem'}}>
```mermaid
Expand Down Expand Up @@ -71,24 +74,24 @@
```
</div>

The high-speed interfaces (`ens1`-`ens8`) handle inter-node communication for <PyTorchTooltip />, <TensorFlowTooltip />, and <SlurmTooltip />. The `eth0` interface on the primary node handles external traffic. See the [configuration reference](/instant-clusters/configuration) for environment variables and network details.

Check warning on line 77 in instant-clusters.mdx

View check run for this annotation

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

instant-clusters.mdx#L77

Use parentheses judiciously.

## Supported hardware

| GPU | Network speed | Nodes |
| --- | ------------- | ----- |
| B200 | 3200 Gbps | 2-8 nodes (16-64 GPUs) |

Check warning on line 83 in instant-clusters.mdx

View check run for this annotation

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

instant-clusters.mdx#L83

Use parentheses judiciously.
| H200 | 3200 Gbps | 2-8 nodes (16-64 GPUs) |

Check warning on line 84 in instant-clusters.mdx

View check run for this annotation

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

instant-clusters.mdx#L84

Use parentheses judiciously.
| H100 | 3200 Gbps | 2-8 nodes (16-64 GPUs) |

Check warning on line 85 in instant-clusters.mdx

View check run for this annotation

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

instant-clusters.mdx#L85

Use parentheses judiciously.
| A100 | 1600 Gbps | 2-8 nodes (16-64 GPUs) |

Check warning on line 86 in instant-clusters.mdx

View check run for this annotation

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

instant-clusters.mdx#L86

Use parentheses judiciously.

For clusters larger than 8 nodes (up to 512 GPUs), [contact our sales team](https://ecykq.share.hsforms.com/2MZdZATC3Rb62Dgci7knjbA).

Check warning on line 88 in instant-clusters.mdx

View check run for this annotation

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

instant-clusters.mdx#L88

Use parentheses judiciously.

Check warning on line 88 in instant-clusters.mdx

View check run for this annotation

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

instant-clusters.mdx#L88

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

## Pricing

Pricing is based on GPU type and number of nodes. See [Instant Clusters pricing](https://www.runpod.io/pricing) for current rates.

Check warning on line 92 in instant-clusters.mdx

View check run for this annotation

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

instant-clusters.mdx#L92

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

Custom pricing is available for enterprise workloads. [Contact our sales team](https://ecykq.share.hsforms.com/2MZdZATC3Rb62Dgci7knjbA) for details.

Check warning on line 94 in instant-clusters.mdx

View check run for this annotation

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

instant-clusters.mdx#L94

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

<Note>
All accounts have a default spending limit. To deploy larger clusters, contact [help@runpod.io](mailto:help@runpod.io).
Expand Down
1 change: 1 addition & 0 deletions instant-clusters/axolotl.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
---

Check warning on line 1 in instant-clusters/axolotl.mdx

View check run for this annotation

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

instant-clusters/axolotl.mdx#L1

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

Check warning on line 1 in instant-clusters/axolotl.mdx

View check run for this annotation

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

instant-clusters/axolotl.mdx#L1

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

Check warning on line 1 in instant-clusters/axolotl.mdx

View check run for this annotation

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

instant-clusters/axolotl.mdx#L1

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

Check warning on line 1 in instant-clusters/axolotl.mdx

View check run for this annotation

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

instant-clusters/axolotl.mdx#L1

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

Check warning on line 1 in instant-clusters/axolotl.mdx

View check run for this annotation

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

instant-clusters/axolotl.mdx#L1

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

Check warning on line 1 in instant-clusters/axolotl.mdx

View check run for this annotation

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

instant-clusters/axolotl.mdx#L1

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

Check warning on line 1 in instant-clusters/axolotl.mdx

View check run for this annotation

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

instant-clusters/axolotl.mdx#L1

Try to keep the Flesch–Kincaid grade level (8.88) below 8.
title: "Deploy an Instant Cluster with Axolotl"
sidebarTitle: "Axolotl"
description: "Deploy a Runpod Cluster with Axolotl and configure multi-GPU distributed training for fine-tuning large language models."
---
import { TrainingTooltip, InferenceTooltip } from "/snippets/tooltips.jsx";

This tutorial demonstrates how to use Instant Clusters with [Axolotl](https://axolotl.ai/) to fine-tune large language models (LLMs) across multiple GPUs. By leveraging PyTorch's distributed <TrainingTooltip /> capabilities and Runpod's high-speed networking infrastructure, you can significantly accelerate your training process compared to single-GPU setups.

Check warning on line 8 in instant-clusters/axolotl.mdx

View check run for this annotation

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

instant-clusters/axolotl.mdx#L8

Use parentheses judiciously.

Follow the steps below to deploy a cluster and start training your models efficiently.

## Step 1: Deploy an Instant Cluster

Check warning on line 12 in instant-clusters/axolotl.mdx

View check run for this annotation

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

instant-clusters/axolotl.mdx#L12

'Step 1: Deploy an Instant Cluster' should use sentence-style capitalization.

1. Open the [Instant Clusters page](https://www.console.runpod.io/cluster) on the Runpod web interface.
2. Click **Create Cluster**.
3. Use the UI to name and configure your Cluster. For this walkthrough, keep **Pod Count** at **2** and select the option for **16x H100 SXM** GPUs. Keep the **Pod Template** at its default setting (Runpod PyTorch).

Check warning on line 16 in instant-clusters/axolotl.mdx

View check run for this annotation

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

instant-clusters/axolotl.mdx#L16

Use parentheses judiciously.

Check warning on line 16 in instant-clusters/axolotl.mdx

View check run for this annotation

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

instant-clusters/axolotl.mdx#L16

Spell out 'SXM', if it's unfamiliar to the audience.
4. Click **Deploy Cluster**. You should be redirected to the Instant Clusters page after a few seconds.

Check warning on line 17 in instant-clusters/axolotl.mdx

View check run for this annotation

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

instant-clusters/axolotl.mdx#L17

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

## Step 2: Set up Axolotl on each Pod

Check warning on line 19 in instant-clusters/axolotl.mdx

View check run for this annotation

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

instant-clusters/axolotl.mdx#L19

'Step 2: Set up Axolotl on each Pod' should use sentence-style capitalization.

1. Click your cluster to expand the list of Pods.

2. Click on a Pod, for example `CLUSTERNAME-pod-0`, to expand the Pod.

Check warning on line 23 in instant-clusters/axolotl.mdx

View check run for this annotation

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

instant-clusters/axolotl.mdx#L23

Use 'click' or 'click in' instead of 'Click on'.

3. Click **Connect**, then click **Web Terminal**.

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

Repeat these steps for **each Pod** in your cluster.

## Step 3: Start the training process on each Pod

Check warning on line 54 in instant-clusters/axolotl.mdx

View check run for this annotation

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

instant-clusters/axolotl.mdx#L54

'Step 3: Start the training process on each Pod' should use sentence-style capitalization.

Run this command in the web terminal of **each Pod**:

Expand Down Expand Up @@ -92,7 +92,7 @@
Congratulations! You've successfully trained a model using Axolotl on an Instant Cluster. Your fine-tuned model has been saved to the `./outputs/lora-out` directory. You can now use this model for <InferenceTooltip /> or continue training with different parameters.
</Check>

## Step 4: Clean up

Check warning on line 95 in instant-clusters/axolotl.mdx

View check run for this annotation

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

instant-clusters/axolotl.mdx#L95

'Step 4: Clean up' should use sentence-style capitalization.

If you no longer need your cluster, make sure you return to the [Instant Clusters page](https://www.console.runpod.io/cluster) and delete your cluster to avoid incurring extra charges.

Expand All @@ -106,8 +106,9 @@

Now that you've successfully deployed and tested an Axolotl distributed training job on an Instant Cluster, you can:

* Review the [fine-tuning guide](/fine-tune) for a complete Axolotl workflow and deployment path.
* **Fine-tune your own models** by modifying the configuration files in Axolotl to suit your specific requirements.
* **Scale your training** by adjusting the number of Pods in your cluster (and the size of their containers and volumes) to handle larger models or datasets.

Check warning on line 111 in instant-clusters/axolotl.mdx

View check run for this annotation

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

instant-clusters/axolotl.mdx#L111

Use parentheses judiciously.
* **Try different optimization techniques** such as DeepSpeed, FSDP (Fully Sharded Data Parallel), or other distributed training strategies.

Check warning on line 112 in instant-clusters/axolotl.mdx

View check run for this annotation

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

instant-clusters/axolotl.mdx#L112

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

Check warning on line 112 in instant-clusters/axolotl.mdx

View check run for this annotation

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

instant-clusters/axolotl.mdx#L112

Use parentheses judiciously.

For more information on fine-tuning with Axolotl, refer to the [Axolotl documentation](https://github.com/axolotl-ai-cloud/axolotl).
4 changes: 2 additions & 2 deletions serverless/development/local-testing.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---

Check warning on line 1 in serverless/development/local-testing.mdx

View check run for this annotation

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

serverless/development/local-testing.mdx#L1

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

Check warning on line 1 in serverless/development/local-testing.mdx

View check run for this annotation

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

serverless/development/local-testing.mdx#L1

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

Check warning on line 1 in serverless/development/local-testing.mdx

View check run for this annotation

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

serverless/development/local-testing.mdx#L1

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

Check warning on line 1 in serverless/development/local-testing.mdx

View check run for this annotation

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

serverless/development/local-testing.mdx#L1

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

Check warning on line 1 in serverless/development/local-testing.mdx

View check run for this annotation

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

serverless/development/local-testing.mdx#L1

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

Check warning on line 1 in serverless/development/local-testing.mdx

View check run for this annotation

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

serverless/development/local-testing.mdx#L1

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

Check warning on line 1 in serverless/development/local-testing.mdx

View check run for this annotation

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

serverless/development/local-testing.mdx#L1

Try to keep the Flesch–Kincaid grade level (8.85) below 8.
title: "Local testing"
description: "Test your Serverless handlers locally before deploying to production. Review configuration and operations guidance for Runpod Serverless."
---

Testing your handler locally before deploying saves time and helps you catch issues early. The Runpod SDK provides multiple ways to test your handler function without consuming cloud resources.
Testing your handler locally before deploying saves time and helps you catch issues early. The Runpod SDK provides multiple ways to test your handler function without consuming cloud resources. See the [Serverless development overview](/serverless/development/overview) for the complete development lifecycle.

## Basic testing

The simplest way to test your handler is by running it directly with test input.

Check warning on line 10 in serverless/development/local-testing.mdx

View check run for this annotation

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

serverless/development/local-testing.mdx#L10

Avoid the unverifiable claim 'simplest'.

### Inline JSON

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

## Local API server

For more comprehensive testing, start a local API server that simulates your Serverless endpoint. This lets you send HTTP requests to test your handler as if it were deployed.

Check warning on line 48 in serverless/development/local-testing.mdx

View check run for this annotation

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

serverless/development/local-testing.mdx#L48

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

Start the local server:

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

### Handling concurrency in your code

If your handler uses shared state (like global variables), use proper synchronization to avoid race conditions:

Check warning on line 100 in serverless/development/local-testing.mdx

View check run for this annotation

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

serverless/development/local-testing.mdx#L100

Use parentheses judiciously.

```python
import runpod
Expand Down Expand Up @@ -149,7 +149,7 @@

### Port

Set a custom port (default is 8000):

Check warning on line 152 in serverless/development/local-testing.mdx

View check run for this annotation

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

serverless/development/local-testing.mdx#L152

Use parentheses judiciously.

```sh
python handler.py --rp_serve_api --rp_api_port 8080
Expand All @@ -157,7 +157,7 @@

### Host

Set the hostname (default is "localhost"):

Check warning on line 160 in serverless/development/local-testing.mdx

View check run for this annotation

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

serverless/development/local-testing.mdx#L160

Use parentheses judiciously.

```sh
python handler.py --rp_serve_api --rp_api_host 0.0.0.0
Expand All @@ -177,8 +177,8 @@
| `--rp_api_port` | Sets the server port | 8000 | `--rp_api_port 8080` |
| `--rp_api_host` | Sets the server hostname | "localhost" | `--rp_api_host 0.0.0.0` |
| `--rp_api_concurrency` | Sets concurrent workers | 1 | `--rp_api_concurrency 4` |
| `--rp_log_level` | Controls log verbosity | INFO | `--rp_log_level DEBUG` |

Check warning on line 180 in serverless/development/local-testing.mdx

View check run for this annotation

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

serverless/development/local-testing.mdx#L180

Spell out 'INFO', if it's unfamiliar to the audience.
| `--rp_debugger` | Enables the debugger | Disabled | `--rp_debugger` |

Check warning on line 181 in serverless/development/local-testing.mdx

View check run for this annotation

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

serverless/development/local-testing.mdx#L181

Use 'turn off' or 'off' instead of 'Disabled'.
| `--test_input` | Provides test input as JSON | N/A | `--test_input '{"input": {}}'` |

## Combined example
Expand All @@ -197,4 +197,4 @@
- Starts the local API server on port 8080.
- Uses 4 concurrent workers.
- Sets the log level to `DEBUG` for maximum information.
- Enables the debugger for troubleshooting.
- Enables the debugger for troubleshooting.
4 changes: 4 additions & 0 deletions serverless/vllm/openai-compatibility.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---

Check warning on line 1 in serverless/vllm/openai-compatibility.mdx

View check run for this annotation

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

serverless/vllm/openai-compatibility.mdx#L1

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

Check warning on line 1 in serverless/vllm/openai-compatibility.mdx

View check run for this annotation

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

serverless/vllm/openai-compatibility.mdx#L1

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

Check warning on line 1 in serverless/vllm/openai-compatibility.mdx

View check run for this annotation

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

serverless/vllm/openai-compatibility.mdx#L1

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

Check warning on line 1 in serverless/vllm/openai-compatibility.mdx

View check run for this annotation

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

serverless/vllm/openai-compatibility.mdx#L1

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

Check warning on line 1 in serverless/vllm/openai-compatibility.mdx

View check run for this annotation

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

serverless/vllm/openai-compatibility.mdx#L1

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

Check warning on line 1 in serverless/vllm/openai-compatibility.mdx

View check run for this annotation

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

serverless/vllm/openai-compatibility.mdx#L1

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

Check warning on line 1 in serverless/vllm/openai-compatibility.mdx

View check run for this annotation

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

serverless/vllm/openai-compatibility.mdx#L1

Try to keep the Flesch reading ease score (32.61) above 70.
title: "OpenAI API compatibility"
sidebarTitle: "OpenAI compatibility"
description: "Use OpenAI client libraries with your vLLM workers. Review setup, configuration, deployment, and operations guidance for Runpod Serverless."
Expand Down Expand Up @@ -39,8 +39,8 @@

| Endpoint | Description |
|----------|-------------|
| `/chat/completions` | Chat model completions (instruction-tuned models) |

Check warning on line 42 in serverless/vllm/openai-compatibility.mdx

View check run for this annotation

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

serverless/vllm/openai-compatibility.mdx#L42

Use parentheses judiciously.
| `/completions` | Text completions (base models) |

Check warning on line 43 in serverless/vllm/openai-compatibility.mdx

View check run for this annotation

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

serverless/vllm/openai-compatibility.mdx#L43

Use parentheses judiciously.
| `/models` | List available models |

## Chat completions
Expand Down Expand Up @@ -119,7 +119,7 @@
## Model name

The `model` parameter must match either:
- The Hugging Face model you deployed (e.g., `mistralai/Mistral-7B-Instruct-v0.2`)

Check warning on line 122 in serverless/vllm/openai-compatibility.mdx

View check run for this annotation

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

serverless/vllm/openai-compatibility.mdx#L122

Use parentheses judiciously.

Check warning on line 122 in serverless/vllm/openai-compatibility.mdx

View check run for this annotation

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

serverless/vllm/openai-compatibility.mdx#L122

Use 'for example' instead of 'e.g.'.
- A custom name set via the `OPENAI_SERVED_MODEL_NAME_OVERRIDE` environment variable

List available models:
Expand All @@ -131,7 +131,7 @@

## Parameters

Standard OpenAI parameters are supported. Include them directly in your request.

Check warning on line 134 in serverless/vllm/openai-compatibility.mdx

View check run for this annotation

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

serverless/vllm/openai-compatibility.mdx#L134

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

<Accordion title="Common parameters">
| Parameter | Type | Default | Description |
Expand Down Expand Up @@ -169,7 +169,7 @@

| Variable | Default | Description |
| --- | --- | --- |
| `RAW_OPENAI_OUTPUT` | `1` | Enable raw OpenAI SSE format for streaming. |

Check warning on line 172 in serverless/vllm/openai-compatibility.mdx

View check run for this annotation

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

serverless/vllm/openai-compatibility.mdx#L172

Spell out 'SSE', if it's unfamiliar to the audience.
| `OPENAI_SERVED_MODEL_NAME_OVERRIDE` | None | Override model name in responses. |
| `OPENAI_RESPONSE_ROLE` | `assistant` | Role for chat completion responses. |

Expand All @@ -190,3 +190,7 @@
| Authentication error | Use your Runpod API key, not an OpenAI key. |
| Timeout errors | Increase client timeout for large models. |
| Unexpected response format | Set `RAW_OPENAI_OUTPUT=1`. |

## Integrate with workflow tools

Follow the [n8n integration guide](/integrations/n8n-integration) to connect an OpenAI-compatible Runpod endpoint to an automated workflow.
14 changes: 14 additions & 0 deletions tutorials/introduction/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---

Check warning on line 1 in tutorials/introduction/overview.mdx

View check run for this annotation

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

tutorials/introduction/overview.mdx#L1

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

Check warning on line 1 in tutorials/introduction/overview.mdx

View check run for this annotation

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

tutorials/introduction/overview.mdx#L1

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

Check warning on line 1 in tutorials/introduction/overview.mdx

View check run for this annotation

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

tutorials/introduction/overview.mdx#L1

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

Check warning on line 1 in tutorials/introduction/overview.mdx

View check run for this annotation

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

tutorials/introduction/overview.mdx#L1

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

Check warning on line 1 in tutorials/introduction/overview.mdx

View check run for this annotation

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

tutorials/introduction/overview.mdx#L1

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

Check warning on line 1 in tutorials/introduction/overview.mdx

View check run for this annotation

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

tutorials/introduction/overview.mdx#L1

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

Check warning on line 1 in tutorials/introduction/overview.mdx

View check run for this annotation

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

tutorials/introduction/overview.mdx#L1

Try to keep the Flesch–Kincaid grade level (9.74) below 8.
title: "Overview"
sidebarTitle: "Overview"
description: "Step-by-step guides for building and deploying AI/ML applications on Runpod. Follow the setup and implementation steps in this Runpod tutorial."
Expand Down Expand Up @@ -27,6 +27,9 @@
<Card title="Generate images with ComfyUI" href="/tutorials/serverless/comfyui" icon="images" horizontal>
Deploy ComfyUI and generate images using JSON workflows.
</Card>
<Card title="Run Ollama on Serverless CPU" href="/tutorials/serverless/run-ollama-inference" icon="microchip" horizontal>
Deploy an Ollama server on CPU workers and send an inference request.
</Card>
</CardGroup>

## Flash
Expand Down Expand Up @@ -60,10 +63,21 @@
</Card>
</CardGroup>

## Public Endpoints

Check warning on line 66 in tutorials/introduction/overview.mdx

View check run for this annotation

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

tutorials/introduction/overview.mdx#L66

'Public Endpoints' should use sentence-style capitalization.

<CardGroup cols={3}>
<Card title="Build a text-to-video pipeline" href="/tutorials/public-endpoints/text-to-video-pipeline" icon="video" horizontal>
Chain multiple Public Endpoints to generate videos from text.
</Card>
</CardGroup>

## More resources

<CardGroup cols={2}>
<Card title="Container tutorials" href="/containers" icon="container-storage" horizontal>
Learn container fundamentals, Dockerfile creation, persistence, and common Docker commands.
</Card>
<Card title="Community video resources" href="/references/video-resources" icon="circle-play" horizontal>
Browse community tutorials about Runpod workflows and supporting Linux tools.
</Card>
</CardGroup>
Loading