|
| 1 | +--- |
| 2 | +title: "Introduction" |
| 3 | +description: "Use the Runpod API to programmatically manage your compute resources." |
| 4 | +--- |
| 5 | + |
| 6 | +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. |
| 7 | + |
| 8 | +Use the Runpod API to: |
| 9 | + |
| 10 | +* Create, monitor, and manage Pods for persistent workloads. |
| 11 | +* Deploy and scale Serverless endpoints for AI inference. |
| 12 | +* Configure network volumes for data persistence. |
| 13 | +* Integrate Runpod's GPU computing power into your existing applications and CI/CD pipelines. |
| 14 | + |
| 15 | +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. |
| 16 | + |
| 17 | +## Available resources |
| 18 | + |
| 19 | +The Runpod API provides complete access to Runpod's core resources: |
| 20 | + |
| 21 | +* **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. |
| 22 | +* **Serverless endpoints**: Deploy and scale containerized applications for AI inference and batch processing. Configure autoscaling parameters, manage worker pools, and monitor job execution in real-time. |
| 23 | +* **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. |
| 24 | +* **Templates**: Save and reuse Pod and endpoint configurations to standardize deployments across projects and teams. |
| 25 | +* **Container registry authentication**: Securely connect to private Docker registries to deploy custom containers and models. |
| 26 | +* **Billing and usage**: Access detailed billing information and resource usage metrics to optimize costs and monitor spending across projects. |
| 27 | + |
| 28 | +## Getting started |
| 29 | + |
| 30 | +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. |
| 31 | + |
| 32 | +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. |
| 33 | + |
| 34 | +## Retrieve the OpenAPI schema |
| 35 | + |
| 36 | +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. |
| 37 | + |
| 38 | +The schema includes all available endpoints, request and response formats, authentication requirements, and data models. |
| 39 | + |
| 40 | +<CodeGroup> |
| 41 | + |
| 42 | +```bash cURL |
| 43 | +curl --request GET \ |
| 44 | + --url https://rest.runpod.io/v1/openapi.json \ |
| 45 | + --header 'Authorization: Bearer RUNPOD_API_KEY' |
| 46 | +``` |
| 47 | + |
| 48 | +```python Python |
| 49 | +import requests |
| 50 | + |
| 51 | +url = "https://rest.runpod.io/v1/openapi.json" |
| 52 | +headers = {"Authorization": "Bearer RUNPOD_API_KEY"} |
| 53 | +response = requests.get(url, headers=headers) |
| 54 | +print(response.json()) |
| 55 | +``` |
| 56 | + |
| 57 | +</CodeGroup> |
| 58 | + |
| 59 | +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. |
| 60 | + |
| 61 | +For detailed endpoint documentation, request/response schemas, and code examples, explore the sections in the sidebar to the left. |
0 commit comments