Skip to content

Commit 8d6b1bc

Browse files
muhsinkingmuhsinking
authored
docs: Simplify and restructure Pods + Serverless + Public Endpoints docs (#549)
2 parents a0635d6 + 25ca410 commit 8d6b1bc

81 files changed

Lines changed: 2714 additions & 4389 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎api-reference/overview.mdx‎

Lines changed: 11 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3,41 +3,24 @@ title: "Overview"
33
description: "Use the Runpod API to programmatically manage your compute resources."
44
---
55

6-
import { PodsTooltip, InferenceTooltip, ServerlessTooltip, NetworkVolumeTooltip, TemplatesTooltip, WorkersTooltip } from "/snippets/tooltips.jsx";
7-
8-
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.
9-
10-
Use the Runpod API to:
11-
12-
* Create, monitor, and manage <PodsTooltip /> for persistent workloads.
13-
* Deploy and scale <ServerlessTooltip /> endpoints for AI <InferenceTooltip />.
14-
* Configure <NetworkVolumeTooltip /> for data persistence.
15-
* Integrate Runpod's GPU computing power into your existing applications and CI/CD pipelines.
16-
17-
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.
6+
The Runpod REST API provides programmatic access to all Runpod compute resources. Integrate GPU infrastructure into your applications, workflows, and automation systems.
187

198
## Available resources
209

21-
The Runpod API provides complete access to Runpod's core resources:
22-
23-
* **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.
24-
* **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.
25-
* **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.
26-
* **Templates**: Save and reuse Pod and endpoint configurations with <TemplatesTooltip /> to standardize deployments across projects and teams.
27-
* **Container registry authentication**: Securely connect to private Docker registries to deploy custom containers and models.
28-
* **Billing and usage**: Access detailed billing information and resource usage metrics to optimize costs and monitor spending across projects.
10+
- **Pods**: Create and manage persistent GPU instances for development, training, and long-running workloads.
11+
- **Serverless endpoints**: Deploy and scale containerized applications with autoscaling and job monitoring.
12+
- **Network volumes**: Create persistent storage attachable to multiple resources.
13+
- **Templates**: Save and reuse Pod and endpoint configurations.
14+
- **Container registry auth**: Connect to private Docker registries.
15+
- **Billing**: Access usage metrics and billing information.
2916

30-
## Getting started
17+
## Authentication
3118

32-
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.
19+
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.
3320

34-
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.
21+
## OpenAPI schema
3522

36-
## Retrieve the OpenAPI schema
37-
38-
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.
39-
40-
The schema includes all available endpoints, request and response formats, authentication requirements, and data models.
23+
Retrieve the complete OpenAPI specification for client generation, request validation, or tooling integration.
4124

4225
<CodeGroup>
4326

@@ -57,7 +40,3 @@ print(response.json())
5740
```
5841

5942
</CodeGroup>
60-
61-
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.
62-
63-
For detailed endpoint documentation, request/response schemas, and code examples, explore the sections in the sidebar to the left.

‎docs.json‎

Lines changed: 121 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,6 @@
9393
"serverless/workers/handler-functions",
9494
"serverless/development/local-testing",
9595
"serverless/development/validation",
96-
"serverless/development/error-handling",
9796
"serverless/development/cleanup",
9897
"serverless/development/write-logs",
9998
"serverless/development/huggingface-models",
@@ -118,6 +117,7 @@
118117
"pages": [
119118
"serverless/endpoints/overview",
120119
"serverless/endpoints/send-requests",
120+
"serverless/endpoints/operation-reference",
121121
"serverless/endpoints/endpoint-configurations",
122122
"serverless/endpoints/model-caching",
123123
"serverless/development/optimization"
@@ -155,7 +155,8 @@
155155
"serverless/vllm/openai-compatibility",
156156
"serverless/vllm/environment-variables"
157157
]
158-
}
158+
},
159+
"serverless/troubleshooting"
159160
]
160161
},
161162
{
@@ -192,6 +193,18 @@
192193
"pods/templates/environment-variables",
193194
"pods/templates/secrets"
194195
]
196+
},
197+
{
198+
"group": "Troubleshooting",
199+
"pages": [
200+
"pods/troubleshooting/zero-gpus",
201+
"pods/troubleshooting/pod-migration",
202+
"pods/troubleshooting/jupyterlab-blank-page",
203+
"pods/troubleshooting/jupyterlab-checkpoints-folder",
204+
"pods/troubleshooting/token-authentication-enabled",
205+
"pods/troubleshooting/storage-full",
206+
"pods/troubleshooting/troubleshooting-502-errors"
207+
]
195208
}
196209
]
197210
},
@@ -210,69 +223,7 @@
210223
"public-endpoints/reference",
211224
"public-endpoints/requests",
212225
"public-endpoints/ai-sdk",
213-
"public-endpoints/ai-coding-tools",
214-
{
215-
"group": "Models",
216-
"pages": [
217-
{
218-
"group": "Image models",
219-
"pages": [
220-
"public-endpoints/models/flux-dev",
221-
"public-endpoints/models/flux-schnell",
222-
"public-endpoints/models/flux-kontext-dev",
223-
"public-endpoints/models/p-image-t2i",
224-
"public-endpoints/models/p-image-edit",
225-
"public-endpoints/models/qwen-image",
226-
"public-endpoints/models/qwen-image-lora",
227-
"public-endpoints/models/qwen-image-edit",
228-
"public-endpoints/models/qwen-image-edit-2511",
229-
"public-endpoints/models/qwen-image-edit-2511-lora",
230-
"public-endpoints/models/seedream-4-t2i",
231-
"public-endpoints/models/seedream-4-edit",
232-
"public-endpoints/models/seedream-3",
233-
"public-endpoints/models/wan-2-6-t2i",
234-
"public-endpoints/models/z-image-turbo",
235-
"public-endpoints/models/nano-banana-edit",
236-
"public-endpoints/models/nano-banana-pro-edit"
237-
]
238-
},
239-
{
240-
"group": "Video models",
241-
"pages": [
242-
"public-endpoints/models/infinitetalk",
243-
"public-endpoints/models/kling-v2-1",
244-
"public-endpoints/models/kling-v2-6-motion-control",
245-
"public-endpoints/models/kling-video-o1-r2v",
246-
"public-endpoints/models/seedance-1-pro",
247-
"public-endpoints/models/seedance-1-5-pro",
248-
"public-endpoints/models/sora-2",
249-
"public-endpoints/models/sora-2-pro",
250-
"public-endpoints/models/wan-2-6-t2v",
251-
"public-endpoints/models/wan-2-5",
252-
"public-endpoints/models/wan-2-2-i2v-lora",
253-
"public-endpoints/models/wan-2-2-i2v",
254-
"public-endpoints/models/wan-2-2-t2v",
255-
"public-endpoints/models/wan-2-1-i2v",
256-
"public-endpoints/models/wan-2-1-t2v"
257-
]
258-
},
259-
{
260-
"group": "Text models",
261-
"pages": [
262-
"public-endpoints/models/granite-4",
263-
"public-endpoints/models/qwen3-32b"
264-
]
265-
},
266-
{
267-
"group": "Audio models",
268-
"pages": [
269-
"public-endpoints/models/chatterbox-turbo",
270-
"public-endpoints/models/whisper-v3",
271-
"public-endpoints/models/minimax-speech"
272-
]
273-
}
274-
]
275-
}
226+
"public-endpoints/ai-coding-tools"
276227
]
277228
},
278229
{
@@ -325,20 +276,7 @@
325276
"references/billing-information",
326277
"references/referrals",
327278
"references/security-and-compliance",
328-
{
329-
"group": "Troubleshooting",
330-
"pages": [
331-
"references/troubleshooting/zero-gpus",
332-
"references/troubleshooting/pod-migration",
333-
"references/troubleshooting/jupyterlab-blank-page",
334-
"references/troubleshooting/jupyterlab-checkpoints-folder",
335-
"references/troubleshooting/token-authentication-enabled",
336-
"references/troubleshooting/leaked-api-keys",
337-
"references/troubleshooting/storage-full",
338-
"references/troubleshooting/troubleshooting-502-errors",
339-
"references/troubleshooting/manage-payment-cards"
340-
]
341-
},
279+
"references/manage-payment-cards",
342280
{
343281
"group": "Migrations",
344282
"pages": [
@@ -565,6 +503,68 @@
565503
}
566504
]
567505
},
506+
{
507+
"tab": "Models",
508+
"groups": [
509+
{
510+
"group": "Image models",
511+
"pages": [
512+
"public-endpoints/models/flux-dev",
513+
"public-endpoints/models/flux-schnell",
514+
"public-endpoints/models/flux-kontext-dev",
515+
"public-endpoints/models/p-image-t2i",
516+
"public-endpoints/models/p-image-edit",
517+
"public-endpoints/models/qwen-image",
518+
"public-endpoints/models/qwen-image-lora",
519+
"public-endpoints/models/qwen-image-edit",
520+
"public-endpoints/models/qwen-image-edit-2511",
521+
"public-endpoints/models/qwen-image-edit-2511-lora",
522+
"public-endpoints/models/seedream-4-t2i",
523+
"public-endpoints/models/seedream-4-edit",
524+
"public-endpoints/models/seedream-3",
525+
"public-endpoints/models/wan-2-6-t2i",
526+
"public-endpoints/models/z-image-turbo",
527+
"public-endpoints/models/nano-banana-edit",
528+
"public-endpoints/models/nano-banana-pro-edit"
529+
]
530+
},
531+
{
532+
"group": "Video models",
533+
"pages": [
534+
"public-endpoints/models/infinitetalk",
535+
"public-endpoints/models/kling-v2-1",
536+
"public-endpoints/models/kling-v2-6-motion-control",
537+
"public-endpoints/models/kling-video-o1-r2v",
538+
"public-endpoints/models/seedance-1-pro",
539+
"public-endpoints/models/seedance-1-5-pro",
540+
"public-endpoints/models/sora-2",
541+
"public-endpoints/models/sora-2-pro",
542+
"public-endpoints/models/wan-2-6-t2v",
543+
"public-endpoints/models/wan-2-5",
544+
"public-endpoints/models/wan-2-2-i2v-lora",
545+
"public-endpoints/models/wan-2-2-i2v",
546+
"public-endpoints/models/wan-2-2-t2v",
547+
"public-endpoints/models/wan-2-1-i2v",
548+
"public-endpoints/models/wan-2-1-t2v"
549+
]
550+
},
551+
{
552+
"group": "Text models",
553+
"pages": [
554+
"public-endpoints/models/granite-4",
555+
"public-endpoints/models/qwen3-32b"
556+
]
557+
},
558+
{
559+
"group": "Audio models",
560+
"pages": [
561+
"public-endpoints/models/chatterbox-turbo",
562+
"public-endpoints/models/whisper-v3",
563+
"public-endpoints/models/minimax-speech"
564+
]
565+
}
566+
]
567+
},
568568
{
569569
"tab": "Release notes",
570570
"groups": [
@@ -622,7 +622,43 @@
622622
},
623623
{
624624
"source": "/references/faq",
625-
"destination": "/references/troubleshooting/zero-gpus"
625+
"destination": "/pods/troubleshooting/zero-gpus"
626+
},
627+
{
628+
"source": "/references/troubleshooting/zero-gpus",
629+
"destination": "/pods/troubleshooting/zero-gpus"
630+
},
631+
{
632+
"source": "/references/troubleshooting/pod-migration",
633+
"destination": "/pods/troubleshooting/pod-migration"
634+
},
635+
{
636+
"source": "/references/troubleshooting/jupyterlab-blank-page",
637+
"destination": "/pods/troubleshooting/jupyterlab-blank-page"
638+
},
639+
{
640+
"source": "/references/troubleshooting/jupyterlab-checkpoints-folder",
641+
"destination": "/pods/troubleshooting/jupyterlab-checkpoints-folder"
642+
},
643+
{
644+
"source": "/references/troubleshooting/token-authentication-enabled",
645+
"destination": "/pods/troubleshooting/token-authentication-enabled"
646+
},
647+
{
648+
"source": "/references/troubleshooting/storage-full",
649+
"destination": "/pods/troubleshooting/storage-full"
650+
},
651+
{
652+
"source": "/references/troubleshooting/troubleshooting-502-errors",
653+
"destination": "/pods/troubleshooting/troubleshooting-502-errors"
654+
},
655+
{
656+
"source": "/references/troubleshooting/manage-payment-cards",
657+
"destination": "/references/manage-payment-cards"
658+
},
659+
{
660+
"source": "/references/troubleshooting/leaked-api-keys",
661+
"destination": "/get-started/api-keys"
626662
},
627663
{
628664
"source": "/references/glossary",
@@ -750,7 +786,11 @@
750786
},
751787
{
752788
"source": "/serverless/workers/handlers/handler-error-handling",
753-
"destination": "/serverless/workers/handler-functions"
789+
"destination": "/serverless/workers/handler-functions#error-handling"
790+
},
791+
{
792+
"source": "/serverless/development/error-handling",
793+
"destination": "/serverless/workers/handler-functions#error-handling"
754794
},
755795
{
756796
"source": "/serverless/workers/handlers/overview",

‎flash/apps/deploy-apps.mdx‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ sidebarTitle: "Deploy to Runpod"
44
description: "Build and deploy your Flash app for production serving."
55
---
66

7-
import { LoadBalancingEndpointsTooltip, QueueBasedEndpointsTooltip } from "/snippets/tooltips.jsx";
8-
97
When you're satisfied with your endpoint functions and ready to move to production, use `flash deploy` to build and deploy your Flash application:
108

119
```bash

‎flash/create-endpoints.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebarTitle: "Create endpoints"
44
description: "Learn how to create and configure hardware and scaling behavior with the Flash Endpoint class."
55
---
66

7-
import { WorkerTooltip, ServerlessTooltip, NetworkVolumesTooltip } from "/snippets/tooltips.jsx";
7+
import { WorkerTooltip, ServerlessTooltip } from "/snippets/tooltips.jsx";
88

99
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:
1010

‎flash/overview.mdx‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ tag: "BETA"
66
mode: "wide"
77
---
88

9-
import { ServerlessTooltip, PodsTooltip, WorkersTooltip, LoadBalancingEndpointsTooltip, QueueBasedEndpointsTooltip, EndpointsTooltip } from "/snippets/tooltips.jsx";
10-
119
<div className="overview-page-wrapper" />
1210

1311
<Note>

‎get-started/manage-accounts.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Manage accounts"
33
description: "Create accounts, manage teams, and configure user permissions in Runpod."
44
---
55

6-
import { PodsTooltip, ServerlessTooltip, InferenceTooltip } from "/snippets/tooltips.jsx";
6+
import { PodsTooltip, ServerlessTooltip } from "/snippets/tooltips.jsx";
77

88
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.
99

0 commit comments

Comments
 (0)