Skip to content

docs: Simplify and restructure Pods + Serverless + Public Endpoints #549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
muhsinking merged 8 commits into from
Mar 12, 2026
Merged

docs: Simplify and restructure Pods + Serverless + Public Endpoints #549

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d81ff9c
Remove "Why use Serverless?" section from Serverless overview
promptless[bot] Mar 11, 2026
c183078
Simplify Pods + Serverless docs
muhsinking Mar 11, 2026
783a5da
Move Public Endpoints reference to new tab, trim tutorials and other …
muhsinking Mar 12, 2026
5efe635
Restructure troubleshooting guides, add troubleshooting for Serverless
muhsinking Mar 12, 2026
2639005
Trim the serverless storage guide.
muhsinking Mar 12, 2026
f8cdcef
Fix tooltip imports
muhsinking Mar 12, 2026
31dbf22
Fix tooltips (again)
muhsinking Mar 12, 2026
25ca410
Update model caching intro
muhsinking Mar 12, 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
43 changes: 11 additions & 32 deletions api-reference/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,24 @@ title: "Overview"
description: "Use the Runpod API to programmatically manage your compute resources."
---

import { PodsTooltip, InferenceTooltip, ServerlessTooltip, NetworkVolumeTooltip, TemplatesTooltip, WorkersTooltip } from "/snippets/tooltips.jsx";

The Runpod API provides programmatic access to all of Runpod's cloud compute resources. It enables you to integrate GPU infrastructure directly into your applications, workflows, and automation systems.

Use the Runpod API to:

* Create, monitor, and manage <PodsTooltip /> for persistent workloads.
* Deploy and scale <ServerlessTooltip /> endpoints for AI <InferenceTooltip />.
* Configure <NetworkVolumeTooltip /> for data persistence.
* Integrate Runpod's GPU computing power into your existing applications and CI/CD pipelines.

The API follows REST principles and returns JSON responses, making it compatible with virtually any programming language or automation tool. Whether you're building a machine learning platform, automating model deployments, or creating custom dashboards for resource management, the Runpod API provides a foundation for seamless integration.
The Runpod REST API provides programmatic access to all Runpod compute resources. Integrate GPU infrastructure into your applications, workflows, and automation systems.

## Available resources

The Runpod API provides complete access to Runpod's core resources:

* **Pods**: Create and manage persistent GPU instances for development, training, and long-running workloads. Control Pod lifecycles, configure hardware specifications, and manage SSH access programmatically.
* **Serverless endpoints**: Deploy and scale containerized applications for AI inference and batch processing. Configure autoscaling parameters, manage <WorkersTooltip /> pools, and monitor job execution in real-time.
* **Network volumes**: Create persistent storage that can be attached to multiple resources. Manage data persistence across Pod restarts and share datasets between different compute instances.
* **Templates**: Save and reuse Pod and endpoint configurations with <TemplatesTooltip /> to standardize deployments across projects and teams.
* **Container registry authentication**: Securely connect to private Docker registries to deploy custom containers and models.
* **Billing and usage**: Access detailed billing information and resource usage metrics to optimize costs and monitor spending across projects.
- **Pods**: Create and manage persistent GPU instances for development, training, and long-running workloads.
- **Serverless endpoints**: Deploy and scale containerized applications with autoscaling and job monitoring.
- **Network volumes**: Create persistent storage attachable to multiple resources.
- **Templates**: Save and reuse Pod and endpoint configurations.
- **Container registry auth**: Connect to private Docker registries.
- **Billing**: Access usage metrics and billing information.

## Getting started
## Authentication

To use the REST API, you'll need a [Runpod API key](/get-started/api-keys) with appropriate permissions for the resources you want to manage. API keys can be generated and managed through your account settings in the Runpod console.
All requests require a [Runpod API key](/get-started/api-keys) in the request headers. The API uses standard HTTP methods and returns JSON responses.

All API requests require authentication using your API key in the request headers. The API uses standard HTTP methods (GET, POST, PATCH, DELETE) and returns JSON responses with detailed error information when needed.
## OpenAPI schema

## Retrieve the OpenAPI schema

You can get the complete OpenAPI specification for the Runpod API using the `/openapi.json` endpoint. Use this to generate client libraries, validate requests, or integrate the API specification into your development tools.

The schema includes all available endpoints, request and response formats, authentication requirements, and data models.
Retrieve the complete OpenAPI specification for client generation, request validation, or tooling integration.

<CodeGroup>

Expand All @@ -57,7 +40,3 @@ print(response.json())
```

</CodeGroup>

The endpoint returns the OpenAPI 3.0 specification in JSON format. You can use it with tools like Swagger UI, Postman, or code generation utilities.

For detailed endpoint documentation, request/response schemas, and code examples, explore the sections in the sidebar to the left.
202 changes: 121 additions & 81 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,6 @@
"serverless/workers/handler-functions",
"serverless/development/local-testing",
"serverless/development/validation",
"serverless/development/error-handling",
"serverless/development/cleanup",
"serverless/development/write-logs",
"serverless/development/huggingface-models",
Expand All @@ -118,6 +117,7 @@
"pages": [
"serverless/endpoints/overview",
"serverless/endpoints/send-requests",
"serverless/endpoints/operation-reference",
"serverless/endpoints/endpoint-configurations",
"serverless/endpoints/model-caching",
"serverless/development/optimization"
Expand Down Expand Up @@ -155,7 +155,8 @@
"serverless/vllm/openai-compatibility",
"serverless/vllm/environment-variables"
]
}
},
"serverless/troubleshooting"
]
},
{
Expand Down Expand Up @@ -192,6 +193,18 @@
"pods/templates/environment-variables",
"pods/templates/secrets"
]
},
{
"group": "Troubleshooting",
"pages": [
"pods/troubleshooting/zero-gpus",
"pods/troubleshooting/pod-migration",
"pods/troubleshooting/jupyterlab-blank-page",
"pods/troubleshooting/jupyterlab-checkpoints-folder",
"pods/troubleshooting/token-authentication-enabled",
"pods/troubleshooting/storage-full",
"pods/troubleshooting/troubleshooting-502-errors"
]
}
]
},
Expand All @@ -210,69 +223,7 @@
"public-endpoints/reference",
"public-endpoints/requests",
"public-endpoints/ai-sdk",
"public-endpoints/ai-coding-tools",
{
"group": "Models",
"pages": [
{
"group": "Image models",
"pages": [
"public-endpoints/models/flux-dev",
"public-endpoints/models/flux-schnell",
"public-endpoints/models/flux-kontext-dev",
"public-endpoints/models/p-image-t2i",
"public-endpoints/models/p-image-edit",
"public-endpoints/models/qwen-image",
"public-endpoints/models/qwen-image-lora",
"public-endpoints/models/qwen-image-edit",
"public-endpoints/models/qwen-image-edit-2511",
"public-endpoints/models/qwen-image-edit-2511-lora",
"public-endpoints/models/seedream-4-t2i",
"public-endpoints/models/seedream-4-edit",
"public-endpoints/models/seedream-3",
"public-endpoints/models/wan-2-6-t2i",
"public-endpoints/models/z-image-turbo",
"public-endpoints/models/nano-banana-edit",
"public-endpoints/models/nano-banana-pro-edit"
]
},
{
"group": "Video models",
"pages": [
"public-endpoints/models/infinitetalk",
"public-endpoints/models/kling-v2-1",
"public-endpoints/models/kling-v2-6-motion-control",
"public-endpoints/models/kling-video-o1-r2v",
"public-endpoints/models/seedance-1-pro",
"public-endpoints/models/seedance-1-5-pro",
"public-endpoints/models/sora-2",
"public-endpoints/models/sora-2-pro",
"public-endpoints/models/wan-2-6-t2v",
"public-endpoints/models/wan-2-5",
"public-endpoints/models/wan-2-2-i2v-lora",
"public-endpoints/models/wan-2-2-i2v",
"public-endpoints/models/wan-2-2-t2v",
"public-endpoints/models/wan-2-1-i2v",
"public-endpoints/models/wan-2-1-t2v"
]
},
{
"group": "Text models",
"pages": [
"public-endpoints/models/granite-4",
"public-endpoints/models/qwen3-32b"
]
},
{
"group": "Audio models",
"pages": [
"public-endpoints/models/chatterbox-turbo",
"public-endpoints/models/whisper-v3",
"public-endpoints/models/minimax-speech"
]
}
]
}
"public-endpoints/ai-coding-tools"
]
},
{
Expand Down Expand Up @@ -325,20 +276,7 @@
"references/billing-information",
"references/referrals",
"references/security-and-compliance",
{
"group": "Troubleshooting",
"pages": [
"references/troubleshooting/zero-gpus",
"references/troubleshooting/pod-migration",
"references/troubleshooting/jupyterlab-blank-page",
"references/troubleshooting/jupyterlab-checkpoints-folder",
"references/troubleshooting/token-authentication-enabled",
"references/troubleshooting/leaked-api-keys",
"references/troubleshooting/storage-full",
"references/troubleshooting/troubleshooting-502-errors",
"references/troubleshooting/manage-payment-cards"
]
},
"references/manage-payment-cards",
{
"group": "Migrations",
"pages": [
Expand Down Expand Up @@ -565,6 +503,68 @@
}
]
},
{
"tab": "Models",
"groups": [
{
"group": "Image models",
"pages": [
"public-endpoints/models/flux-dev",
"public-endpoints/models/flux-schnell",
"public-endpoints/models/flux-kontext-dev",
"public-endpoints/models/p-image-t2i",
"public-endpoints/models/p-image-edit",
"public-endpoints/models/qwen-image",
"public-endpoints/models/qwen-image-lora",
"public-endpoints/models/qwen-image-edit",
"public-endpoints/models/qwen-image-edit-2511",
"public-endpoints/models/qwen-image-edit-2511-lora",
"public-endpoints/models/seedream-4-t2i",
"public-endpoints/models/seedream-4-edit",
"public-endpoints/models/seedream-3",
"public-endpoints/models/wan-2-6-t2i",
"public-endpoints/models/z-image-turbo",
"public-endpoints/models/nano-banana-edit",
"public-endpoints/models/nano-banana-pro-edit"
]
},
{
"group": "Video models",
"pages": [
"public-endpoints/models/infinitetalk",
"public-endpoints/models/kling-v2-1",
"public-endpoints/models/kling-v2-6-motion-control",
"public-endpoints/models/kling-video-o1-r2v",
"public-endpoints/models/seedance-1-pro",
"public-endpoints/models/seedance-1-5-pro",
"public-endpoints/models/sora-2",
"public-endpoints/models/sora-2-pro",
"public-endpoints/models/wan-2-6-t2v",
"public-endpoints/models/wan-2-5",
"public-endpoints/models/wan-2-2-i2v-lora",
"public-endpoints/models/wan-2-2-i2v",
"public-endpoints/models/wan-2-2-t2v",
"public-endpoints/models/wan-2-1-i2v",
"public-endpoints/models/wan-2-1-t2v"
]
},
{
"group": "Text models",
"pages": [
"public-endpoints/models/granite-4",
"public-endpoints/models/qwen3-32b"
]
},
{
"group": "Audio models",
"pages": [
"public-endpoints/models/chatterbox-turbo",
"public-endpoints/models/whisper-v3",
"public-endpoints/models/minimax-speech"
]
}
]
},
{
"tab": "Release notes",
"groups": [
Expand Down Expand Up @@ -622,7 +622,43 @@
},
{
"source": "/references/faq",
"destination": "/references/troubleshooting/zero-gpus"
"destination": "/pods/troubleshooting/zero-gpus"
},
{
"source": "/references/troubleshooting/zero-gpus",
"destination": "/pods/troubleshooting/zero-gpus"
},
{
"source": "/references/troubleshooting/pod-migration",
"destination": "/pods/troubleshooting/pod-migration"
},
{
"source": "/references/troubleshooting/jupyterlab-blank-page",
"destination": "/pods/troubleshooting/jupyterlab-blank-page"
},
{
"source": "/references/troubleshooting/jupyterlab-checkpoints-folder",
"destination": "/pods/troubleshooting/jupyterlab-checkpoints-folder"
},
{
"source": "/references/troubleshooting/token-authentication-enabled",
"destination": "/pods/troubleshooting/token-authentication-enabled"
},
{
"source": "/references/troubleshooting/storage-full",
"destination": "/pods/troubleshooting/storage-full"
},
{
"source": "/references/troubleshooting/troubleshooting-502-errors",
"destination": "/pods/troubleshooting/troubleshooting-502-errors"
},
{
"source": "/references/troubleshooting/manage-payment-cards",
"destination": "/references/manage-payment-cards"
},
{
"source": "/references/troubleshooting/leaked-api-keys",
"destination": "/get-started/api-keys"
},
{
"source": "/references/glossary",
Expand Down Expand Up @@ -750,7 +786,11 @@
},
{
"source": "/serverless/workers/handlers/handler-error-handling",
"destination": "/serverless/workers/handler-functions"
"destination": "/serverless/workers/handler-functions#error-handling"
},
{
"source": "/serverless/development/error-handling",
"destination": "/serverless/workers/handler-functions#error-handling"
},
{
"source": "/serverless/workers/handlers/overview",
Expand Down
2 changes: 0 additions & 2 deletions flash/apps/deploy-apps.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ sidebarTitle: "Deploy to Runpod"
description: "Build and deploy your Flash app for production serving."
---

import { LoadBalancingEndpointsTooltip, QueueBasedEndpointsTooltip } from "/snippets/tooltips.jsx";

When you're satisfied with your endpoint functions and ready to move to production, use `flash deploy` to build and deploy your Flash application:

```bash
Expand Down
2 changes: 1 addition & 1 deletion flash/create-endpoints.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebarTitle: "Create endpoints"
description: "Learn how to create and configure hardware and scaling behavior with the Flash Endpoint class."
---

import { WorkerTooltip, ServerlessTooltip, NetworkVolumesTooltip } from "/snippets/tooltips.jsx";
import { WorkerTooltip, ServerlessTooltip } from "/snippets/tooltips.jsx";

In Flash, endpoints are the bridge between your local Python functions and Runpod's cloud infrastructure. When you decorate a function with `@Endpoint`, you're marking it to run remotely on Runpod <ServerlessTooltip /> instead of your local machine:

Expand Down
2 changes: 0 additions & 2 deletions flash/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ tag: "BETA"
mode: "wide"
---

import { ServerlessTooltip, PodsTooltip, WorkersTooltip, LoadBalancingEndpointsTooltip, QueueBasedEndpointsTooltip, EndpointsTooltip } from "/snippets/tooltips.jsx";

<div className="overview-page-wrapper" />

<Note>
Expand Down
2 changes: 1 addition & 1 deletion get-started/manage-accounts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Manage accounts"
description: "Create accounts, manage teams, and configure user permissions in Runpod."
---

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

To access Runpod resources, you need to either create your own account or join an existing team through an invitation. This guide explains how to set up and manage accounts, teams, and user roles.

Expand Down
Loading
Loading