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
5 changes: 4 additions & 1 deletion api-reference-v2/migrate-from-v1.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "Move your integrations from the Runpod REST API v1 to the v2 base

The Runpod REST API v2 reorganizes resource paths, consolidates Pod lifecycle actions, and standardizes request and response shapes. This guide maps the v1 surface you know to its v2 equivalent so you can update your integrations with confidence.

Read this guide if you have an existing integration built against the v1 API. REST API v1 is deprecated and will be retired on December 1, 2026. Migrate your integrations to v2 before that date.
Read this guide if you have an existing integration built against the v1 API. REST API v1 is deprecated and will be retired on November 15, 2026. Migrate your integrations to v2 before that date.

## What changed at a glance

Expand Down Expand Up @@ -163,4 +163,7 @@ As in v1, Runpod returns a `403` when a valid API key lacks access to the reques
<Card title="List GPU types" href="/api-reference-v2/catalog/list-gpu-types" icon="microchip" horizontal>
Browse available GPU types with the new catalog endpoints.
</Card>
<Card title="Migrate with your coding agent" href="/get-started/agent-skills#migrate-an-existing-integration" icon="wand-magic-sparkles" horizontal>
Use the `/runpod:migrate` command to inventory and rewrite your integration automatically.
</Card>
</CardGroup>
4 changes: 4 additions & 0 deletions api-reference-v2/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ description: "Programmatically manage Runpod resources using the API v2."
---
The Runpod REST API v2 provides programmatic access to your Runpod resources over standard HTTP. Use it to create and manage Pods, query Serverless endpoints, provision storage, and retrieve billing data — without using the console.

<Note>
If you have an existing REST v1 or GraphQL integration, run `/runpod:migrate` with the [Runpod skills plugin](/get-started/agent-skills#migrate-an-existing-integration) installed in your coding agent to migrate it to v2 automatically. See the [migration guide](/api-reference-v2/migrate-from-v1) for details.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirms /runpod:migrate with no scope argument defaults to scope "all", which migrates both REST v1 and GraphQL integrations to v2, matching the doc's claim that running the bare command migrates an existing REST v1 or GraphQL integration.

Source: https://github.com/runpod/runpod-plugins-official/blob/d0c4a7b2a1d7ae30e5429392603fd2d13abf120b/plugins/runpod/commands/migrate.md#L3

</Note>

## Base URL

```
Expand Down
2 changes: 1 addition & 1 deletion api-reference/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "Use the Runpod API to programmatically manage your compute resourc
The Runpod REST API v1 provides programmatic access to all Runpod compute resources. Integrate GPU infrastructure into your applications, workflows, and automation systems.

<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.
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).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirms rest is a valid scope argument for /runpod:migrate that targets REST v1 only, matching the doc's claim that /runpod:migrate rest migrates the REST v1 integration.

Source: https://github.com/runpod/runpod-plugins-official/blob/d0c4a7b2a1d7ae30e5429392603fd2d13abf120b/plugins/runpod/commands/migrate.md#L3

</Warning>

## Available resources
Expand Down
21 changes: 21 additions & 0 deletions get-started/agent-skills.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ The plugin installs a router and a set of focused skills:
| **flash** | Writes and deploys your own Python code to Runpod Serverless using the [runpod-flash](/flash/overview) SDK. |
| **companion-clis** | Uses supporting CLIs such as Hugging Face, Docker, and the AWS CLI when a task needs them. |
| **runpod-usage** | Provides conceptual knowledge about Pods, Serverless, storage, and GPU selection. |
| **runpod-migrate** | Migrates a codebase from the GraphQL API or REST v1 to REST v2. It inventories which API each call site uses, rewrites the call sites, and verifies the result. |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirms the runpod-migrate skill's description: migrates a codebase from the GraphQL API or REST v1 to REST v2, inventorying which API version each call site uses, rewriting call sites, and verifying — matching the new table row.

Source: https://github.com/runpod/runpod-plugins-official/blob/d0c4a7b2a1d7ae30e5429392603fd2d13abf120b/plugins/runpod/skills/runpod-migrate/SKILL.md#L4


The plugin also includes a collection of worked, end-to-end reference tasks, such as deploying a Whisper endpoint or running a model on a Pod, that guide your agent through common workflows.

Expand All @@ -75,6 +76,26 @@ Once installed, you can ask your agent to perform tasks like the following:
| Deploy with Flash | "Deploy this function to a remote GPU with Flash" |
| Local development | "Start a local dev server with Flash" |

## Migrate an existing integration

If you already have an integration built on the GraphQL API or REST v1, the `/runpod:migrate` command moves it to REST v2. It inventories which API version each part of your code uses, then rewrites the call sites, flags breaking changes, and verifies the result. It migrates one file at a time, with one commit per file.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirms the /runpod:migrate workflow inventories call sites, rewrites them, flags breaking changes, verifies the result, and migrates "one file per commit" (SKILL.md step 4 heading: "Migrate, one file per commit"), matching the section's description of the command's behavior.

Source: https://github.com/runpod/runpod-plugins-official/blob/d0c4a7b2a1d7ae30e5429392603fd2d13abf120b/plugins/runpod/skills/runpod-migrate/SKILL.md#L178


Because it edits and commits your code as it goes, run it on a feature branch and review each commit before you merge or deploy.

The command takes an optional scope and path:

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirms the verbatim argument-hint for the /runpod:migrate command: "[scope: all | rest | graphql] [path]", matching the invocation syntax shown in the code block.

Source: https://github.com/runpod/runpod-plugins-official/blob/d0c4a7b2a1d7ae30e5429392603fd2d13abf120b/plugins/runpod/commands/migrate.md#L3

```bash
/runpod:migrate [scope: all | rest | graphql] [path]
```

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirms scope defaults to "all" (both REST v1 and GraphQL) and path defaults to the current working directory when no arguments are given, matching the doc's explanation of scope/path defaults.

Source: https://github.com/runpod/runpod-plugins-official/blob/d0c4a7b2a1d7ae30e5429392603fd2d13abf120b/plugins/runpod/commands/migrate.md#L13


`scope` defaults to `all`, which covers both REST v1 and GraphQL. Use `rest` to target REST v1 only, or `graphql` to target GraphQL only. `path` defaults to the current directory. For example, to migrate only the REST v1 code under `src/`:

```bash
/runpod:migrate rest src/
```

Running the command requires the Runpod skills plugin installed in your coding agent (see [Quick start](#quick-start)). For a manual walkthrough of the API changes, see the [migration guide](/api-reference-v2/migrate-from-v1).

## Native install options

The `npx skills add` command above works everywhere. If you'd rather install the plugin through your agent's native marketplace, use the route for your agent below. Each route installs the same router and skills.
Expand Down
2 changes: 1 addition & 1 deletion sdks/graphql/configurations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Use the GraphQL API to manage Pods, templates, and Serverless endpoints through
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](https://graphql-spec.runpod.io/).

<Warning>
The GraphQL API is deprecated and will be retired in early 2027. For new integrations, use [REST API v2](/api-reference-v2/overview).
The GraphQL API is deprecated and will be retired in early 2027. For new integrations, use [REST API v2](/api-reference-v2/overview). To migrate automatically, ask your coding agent to run `/runpod:migrate graphql` once you've installed the [Runpod skills plugin](/get-started/agent-skills#migrate-an-existing-integration).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirms graphql is a valid scope argument for /runpod:migrate that targets the GraphQL API only, matching the doc's claim that /runpod:migrate graphql migrates the GraphQL integration.

Source: https://github.com/runpod/runpod-plugins-official/blob/d0c4a7b2a1d7ae30e5429392603fd2d13abf120b/plugins/runpod/commands/migrate.md#L3

</Warning>

## Quick start
Expand Down
Loading