Overview

Use the GraphQL API to manage Pods, templates, and Serverless endpoints through queries and mutations. All requests go to https://api.runpod.io/graphql with your API key included as a query parameter. For the complete schema including all available queries, mutations, fields, and inputs, see the GraphQL Spec.

The GraphQL API is deprecated and will be retired in early 2027. For new integrations, use REST API v2. To migrate automatically, ask your coding agent to run /runpod:migrate graphql once you’ve installed the Runpod skills plugin.

Quick start

Make a request using cURL:

curl --request POST \
  --header 'content-type: application/json' \
  --url 'https://api.runpod.io/graphql?api_key=YOUR_API_KEY' \
  --data '{"query": "query { myself { id email } }"}'

Or use a GraphQL client:

query {
  myself {
    id
    email
  }
}

Common operations

Manage Pods

Create, start, stop, and query Pods.

Manage templates

Create and manage Pod and Serverless templates.

Manage endpoints

Create and configure Serverless endpoints.

Common input fields

The following fields are commonly used when creating Pods and templates.

Field	Type	Description
`containerDiskInGb`	Integer	Size of the container disk in GB. Used for the operating system, installed applications, and temporary data.
`volumeInGb`	Integer	Size of the persistent volume in GB. Data persists between Pod restarts.
`imageName`	String	Docker image name including repository and tag (e.g., `nginx:latest`).
`name`	String	Name for the resource. Must be unique within your account.
`dockerArgs`	String	Overrides the container’s default start command. If not specified, uses the image’s CMD.
`env`	Array	Environment variables as key-value pairs (e.g., `[{key: "VAR", value: "value"}]`).
`ports`	String	Ports to expose, formatted as `port/protocol` (e.g., `8888/http,22/tcp`).
`gpuTypeId`	String	GPU type identifier (e.g., `NVIDIA RTX A6000`). Use the `gpuTypes` query to list available options.
`gpuCount`	Integer	Number of GPUs to allocate.
`containerRegistryAuthId`	String	ID of saved registry credentials for private container images. Find this in your Runpod settings.

Get started

Flash

Serverless

Pods

Storage

Public Endpoints

Instant Clusters

Accounts and billing

Organizations (Beta)

Integrations

Hub

Reference

Quick start

Common operations

Manage Pods

Manage templates

Manage endpoints

Common input fields

​Quick start

​Common operations

Manage Pods

Manage templates

Manage endpoints

​Common input fields

Quick start

Common operations

Common input fields