Skip to content
10 changes: 10 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,16 @@
"get-started/early-access"
]
},
{
"group": "Runpod SDK",
"pages": [
"sdk/overview",
"sdk/quickstart",
"sdk/cli",
"sdk/whats-changed",
"sdk/runtime"
]
},
{
"group": "Flash",
"pages": [
Expand Down
7 changes: 6 additions & 1 deletion flash/apps/apps-and-environments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@
title: "Apps and environments"
sidebarTitle: "Apps and environments"
description: "Understanding Flash's two-level deployment structure for organizing projects and managing deployments."
canonical: "https://docs.runpod.io/sdk/overview"
---

<Warning>
Flash is now part of the [Runpod SDK](/sdk/overview). This page documents the standalone `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [Runpod SDK](/sdk/overview). To see how Flash commands and imports map to the SDK, see [What changed](/sdk/whats-changed).
</Warning>

Flash uses a two-level organizational structure for deployments: **apps** and **environments**. Understanding this structure helps you organize projects, manage multiple deployment stages, and isolate resources effectively.

## Flash apps
Expand Down Expand Up @@ -167,4 +172,4 @@ uv run flash env list

<Warning>
Deleting an app or environment is irreversible. All endpoints and configuration are permanently removed.
</Warning>
</Warning>
5 changes: 5 additions & 0 deletions flash/apps/build-app.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@
title: "Build a Flash app"
sidebarTitle: "Build a Flash app"
description: "Create a Flash app, test it locally, and deploy it to production. Review setup, configuration, deployment, and usage guidance for Runpod Flash."
canonical: "https://docs.runpod.io/sdk/overview"
---

<Warning>
Flash is now part of the [Runpod SDK](/sdk/overview). This page documents the standalone `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [Runpod SDK](/sdk/overview). To see how Flash commands and imports map to the SDK, see [What changed](/sdk/whats-changed).
</Warning>

Flash apps let you build APIs to serve AI/ML workloads on Runpod Serverless. This guide walks you through the process of building a Flash app from scratch, from project initialization and local testing to production deployment.

<Tip>
Expand Down
5 changes: 5 additions & 0 deletions flash/apps/customize-app.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,15 @@
title: "Customize your Flash app"
sidebarTitle: "Customize your app"
description: "Modify the Flash project template to build your application. Review setup, configuration, deployment, and usage guidance for Runpod Flash."
canonical: "https://docs.runpod.io/sdk/overview"
---

import { LoadBalancingEndpointsTooltip, QueueBasedEndpointsTooltip } from "/snippets/tooltips.jsx";

<Warning>
Flash is now part of the [Runpod SDK](/sdk/overview). This page documents the standalone `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [Runpod SDK](/sdk/overview). To see how Flash commands and imports map to the SDK, see [What changed](/sdk/whats-changed).
</Warning>

After running `flash init`, you have a working project template with example <LoadBalancingEndpointsTooltip /> and <QueueBasedEndpointsTooltip />. This guide shows you how to customize the template to build your application.

## Endpoint types
Expand Down
5 changes: 5 additions & 0 deletions flash/apps/deploy-apps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@
title: "Deploy Flash apps to Runpod"
sidebarTitle: "Deploy to Runpod"
description: "Build and deploy your Flash app for production serving. Review setup, configuration, deployment, and usage guidance for Runpod Flash."
canonical: "https://docs.runpod.io/sdk/overview"
---

<Warning>
Flash is now part of the [Runpod SDK](/sdk/overview). This page documents the standalone `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [Runpod SDK](/sdk/overview). To see how Flash commands and imports map to the SDK, see [What changed](/sdk/whats-changed).
</Warning>

When you're satisfied with your endpoint functions and ready to move to production, use `flash deploy` to build and deploy your Flash application:

```bash
Expand Down
5 changes: 5 additions & 0 deletions flash/apps/initialize-project.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,15 @@
title: "Initialize a Flash app project"
sidebarTitle: "Initialize a project"
description: "Use flash init to create a new Flash project with a ready-to-use structure. Review configuration and usage details for Runpod Flash."
canonical: "https://docs.runpod.io/sdk/overview"
---

import { LoadBalancingEndpointsTooltip, QueueBasedEndpointsTooltip } from "/snippets/tooltips.jsx";

<Warning>
Flash is now part of the [Runpod SDK](/sdk/overview). This page documents the standalone `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [Runpod SDK](/sdk/overview). To see how Flash commands and imports map to the SDK, see [What changed](/sdk/whats-changed).
</Warning>

The `flash init` command creates a new Flash project with a complete project structure, including example <LoadBalancingEndpointsTooltip /> and <QueueBasedEndpointsTooltip />, and configuration files. This gives you a working starting point for building Flash applications.

Use `flash init` whenever you want to start a new Flash project, fully configured for you to run `flash dev` and `flash deploy`.
Expand Down
5 changes: 5 additions & 0 deletions flash/apps/local-testing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@
title: "Test Flash apps locally"
sidebarTitle: "Test locally"
description: "Use flash dev to test your Flash application locally before deploying. Review setup, configuration, deployment, and usage guidance for Runpod Flash."
canonical: "https://docs.runpod.io/sdk/overview"
---

<Warning>
Flash is now part of the [Runpod SDK](/sdk/overview). This page documents the standalone `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [Runpod SDK](/sdk/overview). To see how Flash commands and imports map to the SDK, see [What changed](/sdk/whats-changed).
</Warning>

The `flash dev` command starts a local development server that lets you test your Flash application before deploying to production. The development server runs locally and updates automatically as you edit files.

When you call a `@Endpoint` function, Flash sends the latest function code to Serverless workers on Runpod, so your changes are reflected immediately.
Expand Down
5 changes: 5 additions & 0 deletions flash/apps/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,15 @@
title: "Overview"
sidebarTitle: "Overview"
description: "Understand the Flash app development lifecycle. Review setup, configuration, deployment, and usage guidance for Runpod Flash."
canonical: "https://docs.runpod.io/sdk/overview"
---

import { ServerlessTooltip } from "/snippets/tooltips.jsx";

<Warning>
Flash is now part of the [Runpod SDK](/sdk/overview). This page documents the standalone `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [Runpod SDK](/sdk/overview). To see how Flash commands and imports map to the SDK, see [What changed](/sdk/whats-changed).
</Warning>

A Flash app is a collection of <ServerlessTooltip /> endpoints deployed to Runpod.

<CardGroup cols={2}>
Expand Down
5 changes: 5 additions & 0 deletions flash/apps/requests.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@
title: "Send API requests to deployed endpoints"
sidebarTitle: "Send API requests"
description: "Call your deployed Flash endpoints using HTTP requests for queue-based and load-balanced configurations."
canonical: "https://docs.runpod.io/sdk/overview"
---

<Warning>
Flash is now part of the [Runpod SDK](/sdk/overview). This page documents the standalone `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [Runpod SDK](/sdk/overview). To see how Flash commands and imports map to the SDK, see [What changed](/sdk/whats-changed).
</Warning>

After deploying your Flash app with `flash deploy`, you can call your endpoints directly via HTTP. The request format depends on whether you're using queue-based or load-balanced configurations.

## Authentication
Expand Down
5 changes: 5 additions & 0 deletions flash/cli/app.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@
title: "app"
sidebarTitle: "app"
description: "Create, inspect, list, and delete Flash applications that organize deployment environments, build artifacts, and configuration."
canonical: "https://docs.runpod.io/sdk/cli"
---

<Warning>
The Flash CLI is now part of the `rp` CLI that ships with the [Runpod SDK](/sdk/overview). This page documents the standalone `flash` command from the `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [`rp` CLI](/sdk/cli). To see how `flash` commands map to `rp flash`, see [What changed](/sdk/whats-changed#cli-commands).
</Warning>

Manage Flash applications. An app is the top-level container that groups your deployment environments, build artifacts, and configuration.

```bash Command
Expand Down
7 changes: 6 additions & 1 deletion flash/cli/build.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@
title: "build"
sidebarTitle: "build"
description: "Build a deployment-ready Flash application artifact without deploying, with controls for dependencies, exclusions, and output files."
canonical: "https://docs.runpod.io/sdk/cli"
---

<Warning>
The Flash CLI is now part of the `rp` CLI that ships with the [Runpod SDK](/sdk/overview). This page documents the standalone `flash` command from the `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [`rp` CLI](/sdk/cli). To see how `flash` commands map to `rp flash`, see [What changed](/sdk/whats-changed#cli-commands).
</Warning>

Build a deployment-ready artifact for your Flash application without deploying. Use this for more control over the build process or to inspect the artifact before deploying.

```bash
Expand Down Expand Up @@ -83,7 +88,7 @@ Local (non-pip) modules that your endpoints import are bundled automatically, pr

If shipped code imports a local module that an ignore rule excludes (for example, a `test_*.py` sibling or a file under `tests/`), the build fails with a `LocalModuleResolutionError` instead of silently overriding your ignore rules or shipping a broken artifact. Flash names each excluded file and the file that imports it:

```
```text
Shipped code imports local modules that the build ignore rules (.gitignore or built-in defaults) exclude:
utils/helpers.py (imported by endpoint.py)

Expand Down
5 changes: 5 additions & 0 deletions flash/cli/deploy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@
title: "deploy"
sidebarTitle: "deploy"
description: "Build and deploy a Flash application to Runpod Serverless, select an environment, preview the build, and control packaged dependencies."
canonical: "https://docs.runpod.io/sdk/cli"
---

<Warning>
The Flash CLI is now part of the `rp` CLI that ships with the [Runpod SDK](/sdk/overview). This page documents the standalone `flash` command from the `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [`rp` CLI](/sdk/cli). To see how `flash` commands map to `rp flash`, see [What changed](/sdk/whats-changed#cli-commands).
</Warning>

Build and deploy your Flash application to Runpod Serverless endpoints in one step. This is the primary command for getting your application running in the cloud.

```bash
Expand Down
5 changes: 5 additions & 0 deletions flash/cli/dev.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@
title: "dev"
sidebarTitle: "dev"
description: "Run a local Flash development server, test Endpoint functions on Runpod Serverless, and configure provisioning, ports, and updates."
canonical: "https://docs.runpod.io/sdk/cli"
---

<Warning>
The Flash CLI is now part of the `rp` CLI that ships with the [Runpod SDK](/sdk/overview). This page documents the standalone `flash` command from the `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [`rp` CLI](/sdk/cli). To see how `flash` commands map to `rp flash`, see [What changed](/sdk/whats-changed#cli-commands).
</Warning>

Start the Flash development server for local testing with automatic updates. A local development server provides a unified interface for testing while `@Endpoint` functions execute on Runpod Serverless.

```bash
Expand Down
5 changes: 5 additions & 0 deletions flash/cli/env.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@
title: "env"
sidebarTitle: "env"
description: "Create, inspect, list, and delete isolated Flash deployment environments for development, staging, and production applications."
canonical: "https://docs.runpod.io/sdk/cli"
---

<Warning>
The Flash CLI is now part of the `rp` CLI that ships with the [Runpod SDK](/sdk/overview). This page documents the standalone `flash` command from the `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [`rp` CLI](/sdk/cli). To see how `flash` commands map to `rp flash`, see [What changed](/sdk/whats-changed#cli-commands).
</Warning>

Manage deployment environments for Flash applications. Environments are isolated deployment contexts (like `dev`, `staging`, `production`) within a Flash app.

```bash Command
Expand Down
5 changes: 5 additions & 0 deletions flash/cli/init.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@
title: "init"
sidebarTitle: "init"
description: "Initialize a Flash project with a FastAPI server, example GPU and CPU workers, configuration files, and a ready-to-run directory structure."
canonical: "https://docs.runpod.io/sdk/cli"
---

<Warning>
The Flash CLI is now part of the `rp` CLI that ships with the [Runpod SDK](/sdk/overview). This page documents the standalone `flash` command from the `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [`rp` CLI](/sdk/cli). To see how `flash` commands map to `rp flash`, see [What changed](/sdk/whats-changed#cli-commands).
</Warning>

Create a new Flash project with a ready-to-use template structure including a FastAPI server, example GPU and CPU workers, and configuration files.

```bash
Expand Down
5 changes: 5 additions & 0 deletions flash/cli/login.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@
title: "login"
sidebarTitle: "login"
description: "Authenticate the Flash CLI with Runpod, save your API key locally, and configure browser-based authorization options and timeouts."
canonical: "https://docs.runpod.io/sdk/cli"
---

<Warning>
The Flash CLI is now part of the `rp` CLI that ships with the [Runpod SDK](/sdk/overview). This page documents the standalone `flash` command from the `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [`rp` CLI](/sdk/cli). To see how `flash` commands map to `rp flash`, see [What changed](/sdk/whats-changed#cli-commands).
</Warning>

Authenticate with Runpod and save your API key for all Flash operations, including CLI commands and standalone `@Endpoint` functions.

```bash
Expand Down
7 changes: 6 additions & 1 deletion flash/cli/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,13 @@ title: "CLI overview"
sidebarTitle: "Overview"
description: "Learn how to use the Flash CLI for local development and deployment. Review setup, configuration, deployment, and usage guidance for Runpod Flash."
tag: "BETA"
canonical: "https://docs.runpod.io/sdk/cli"
---

<Warning>
The Flash CLI is now part of the `rp` CLI that ships with the [Runpod SDK](/sdk/overview). This page documents the standalone `flash` command from the `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [`rp` CLI](/sdk/cli). To see how `flash` commands map to `rp flash`, see [What changed](/sdk/whats-changed#cli-commands).
</Warning>

The Flash CLI provides commands for initializing projects, running local development servers, building deployment artifacts, and managing your applications on Runpod Serverless.

Before using the CLI, make sure you've [installed Flash](/flash/overview#install-flash).
Expand Down Expand Up @@ -110,4 +115,4 @@ flash undeploy ENDPOINT_NAME

# Remove all endpoints
flash undeploy --all
```
```
5 changes: 5 additions & 0 deletions flash/cli/undeploy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@
title: "undeploy"
sidebarTitle: "undeploy"
description: "List or delete Runpod Serverless endpoints created by Flash, including individual deployments and local development resources."
canonical: "https://docs.runpod.io/sdk/cli"
---

<Warning>
The Flash CLI is now part of the `rp` CLI that ships with the [Runpod SDK](/sdk/overview). This page documents the standalone `flash` command from the `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [`rp` CLI](/sdk/cli). To see how `flash` commands map to `rp flash`, see [What changed](/sdk/whats-changed#cli-commands).
</Warning>

Manage and delete Runpod Serverless endpoints deployed via Flash. Use this command to clean up endpoints created during local development with `flash dev`.

```bash
Expand Down
7 changes: 6 additions & 1 deletion flash/cli/update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@
title: "update"
sidebarTitle: "update"
description: "Update the Flash CLI to the latest or a selected version, understand automatic update checks, and configure when those checks run."
canonical: "https://docs.runpod.io/sdk/cli"
---

<Warning>
The Flash CLI is now part of the `rp` CLI that ships with the [Runpod SDK](/sdk/overview). This page documents the standalone `flash` command from the `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [`rp` CLI](/sdk/cli). To see how `flash` commands map to `rp flash`, see [What changed](/sdk/whats-changed#cli-commands).
</Warning>

Update the Flash CLI to the latest version or a specific version. The command fetches version information from PyPI and installs using uv (when available) or pip.

```bash
Expand Down Expand Up @@ -34,7 +39,7 @@ Target version to install. If not specified, updates to the latest version avail

Flash checks for newer versions in the background when you run most commands. If an update is available, a notice appears after the command completes:

```
```text
A new version of runpod-flash is available: 2.0.0
Run 'flash update' to upgrade.
```
Expand Down
7 changes: 6 additions & 1 deletion flash/configuration/best-practices.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@
title: "Configuration best practices"
sidebarTitle: "Best practices"
description: "Recommended configurations for production, development, and cost optimization. Review configuration and usage details for Runpod Flash."
canonical: "https://docs.runpod.io/sdk/overview"
---

<Warning>
Flash is now part of the [Runpod SDK](/sdk/overview). This page documents the standalone `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [Runpod SDK](/sdk/overview). To see how Flash commands and imports map to the SDK, see [What changed](/sdk/whats-changed).
</Warning>

This guide provides best practices for configuring Flash endpoints based on your use case. Recommendations are organized by workload type and optimization goal.

## Production workloads
Expand Down Expand Up @@ -167,4 +172,4 @@ Before deploying to production, verify:
- **Storage**: Network volume attached if using large models or datasets
- **Environment variables**: All configuration and secrets passed via `env` parameter
- **Monitoring**: Health check routes implemented (load balancers)
- **Testing**: Tested locally with `flash dev` before production deployment
- **Testing**: Tested locally with `flash dev` before production deployment
5 changes: 5 additions & 0 deletions flash/configuration/cpu-types.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@
title: "CPU types"
sidebarTitle: "CPU types"
description: "Available CPU instance types for Flash endpoints. Review setup, configuration, deployment, and usage guidance for Runpod Flash."
canonical: "https://docs.runpod.io/sdk/overview"
---

<Warning>
Flash is now part of the [Runpod SDK](/sdk/overview). This page documents the standalone `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [Runpod SDK](/sdk/overview). To see how Flash commands and imports map to the SDK, see [What changed](/sdk/whats-changed).
</Warning>

Flash provides access to CPU-only compute instances for workloads that don't require GPU acceleration. This reference lists all available CPU instance types.

## Using CPU instances
Expand Down
5 changes: 5 additions & 0 deletions flash/configuration/gpu-types.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@
title: "GPU types"
sidebarTitle: "GPU types"
description: "Available GPU pools and specific GPU types for Flash endpoints. Review setup, configuration, deployment, and usage guidance for Runpod Flash."
canonical: "https://docs.runpod.io/sdk/overview"
---

<Warning>
Flash is now part of the [Runpod SDK](/sdk/overview). This page documents the standalone `runpod-flash` package, which keeps working but no longer gets new features. For new projects, use the [Runpod SDK](/sdk/overview). To see how Flash commands and imports map to the SDK, see [What changed](/sdk/whats-changed).
</Warning>

Flash provides access to a wide range of NVIDIA GPUs through both pool-based and specific GPU selection. This page lists all available GPU types and explains how to use them.

## GPU selection methods
Expand Down
Loading
Loading