diff --git a/api-reference-v2/migrate-from-v1.mdx b/api-reference-v2/migrate-from-v1.mdx index a98ca9a02..b958c9a39 100644 --- a/api-reference-v2/migrate-from-v1.mdx +++ b/api-reference-v2/migrate-from-v1.mdx @@ -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 @@ -163,4 +163,7 @@ As in v1, Runpod returns a `403` when a valid API key lacks access to the reques Browse available GPU types with the new catalog endpoints. + + Use the `/runpod:migrate` command to inventory and rewrite your integration automatically. + diff --git a/api-reference-v2/overview.mdx b/api-reference-v2/overview.mdx index cc0bbcd6b..3ba549e76 100644 --- a/api-reference-v2/overview.mdx +++ b/api-reference-v2/overview.mdx @@ -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. + +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. + + ## Base URL ``` diff --git a/api-reference/overview.mdx b/api-reference/overview.mdx index 3bb34dff1..0a0ed52b9 100644 --- a/api-reference/overview.mdx +++ b/api-reference/overview.mdx @@ -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. -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). ## Available resources diff --git a/get-started/agent-skills.mdx b/get-started/agent-skills.mdx index f9f25a3b8..d7360c890 100644 --- a/get-started/agent-skills.mdx +++ b/get-started/agent-skills.mdx @@ -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. | 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. @@ -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. + +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: + +```bash +/runpod:migrate [scope: all | rest | graphql] [path] +``` + +`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. diff --git a/sdks/graphql/configurations.mdx b/sdks/graphql/configurations.mdx index 5f10a307d..ea77cdc25 100644 --- a/sdks/graphql/configurations.mdx +++ b/sdks/graphql/configurations.mdx @@ -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/). -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). ## Quick start