Warp Platform API quickstart

The Warp Platform API lets you run and manage cloud agents from CI/CD pipelines, backend services, scripts, or custom tooling without the Warp desktop app. This quickstart walks you through creating your first run and checking its status.

To dispatch work through a factory's named agents and workflow, use factory endpoints after this quickstart. The run-management steps below also apply to the factory run those endpoints create.

Watch this short demo of how the REST API can power agent-backed apps like PowerFixer, an issue triage bot built by the Warp team:

Prerequisites

• A Warp API key - Create one in the <a href=$https://oz.warp.dev/settings>Oz web app and copy the raw value. Use a personal key if you want runs attributed to you, or an agent key to attribute runs to a cloud agent. See API Keys for the full flow.
• A cloud environment - Agents run inside a configured environment that includes repos and other dependencies. If you don't have an environment yet, follow the Cloud Agents Quickstart first.

1. Set your API key

Export your API key so the API can authenticate your requests automatically — all commands in this guide reference the WARP_API_KEY environment variable.

export WARP_API_KEY="wk-..."

Replace wk-... with the key you created earlier.

2. Create your first run

Submit a prompt to start an agent run:

curl -X POST https://app.warp.dev/api/v1/agent/runs \
  -H "Authorization: Bearer $WARP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Scan the repo for outdated dependencies and summarize the findings.",
    "config": {
      "environment_id": "<ENV_ID>"
    }
  }'

Replace `` with your environment ID. Find it with oz environment list on the Oz CLI or in the <a href=https://oz.warp.dev>Oz web app.

The API returns a run_id immediately. The agent starts asynchronously — you can check its status at any time using the run ID.

3. Check run status

Fetch the current state of the run with the following command. Replace `` with the run_id from step 2.

curl "https://app.warp.dev/api/v1/agent/runs/<RUN_ID>" \
  -H "Authorization: Bearer $WARP_API_KEY"

The state has the following possible values:

• QUEUED - The run is waiting to start.
• INPROGRESS - The agent is actively running.
• SUCCEEDED - The run completed successfully.
• FAILED - The run encountered an error. Check the status_message field in the response for details, then use the API error reference to interpret the error code.

These are the most common states. See the Agent & run endpoints and Warp Platform API reference for all possible values.

To list all recent runs:

curl "https://app.warp.dev/api/v1/agent/runs" \
  -H "Authorization: Bearer $WARP_API_KEY"

4. View the results

Once the run reaches SUCCEEDED, the response includes a session_link — a direct URL to the full run transcript, including commands executed, files changed, and agent output.

You can also view and manage all runs in the <a href=$https://oz.warp.dev/runs>cloud agent dashboard.

Next steps

• Read the endpoint guide - Agent & run endpoints documents the configuration and run lifecycle, while the Warp Platform API reference lists all parameters, query filters, and response schemas.
• Explore the SDKs - warp-platform-sdk for Python and @warp-dot-dev/warp-platform-sdk for TypeScript include typed request/response models, retries, and error handling.
• See a real-world example - Demo: Sentry monitoring with SDK shows how to build a webhook handler that triggers agents from production errors.
• Schedule and automate - See Scheduled Agents Quickstart to run agents on a cron, or Integrations Quickstart to trigger agents from Slack or Linear.