Warp · Example Payload

Warp Run Agent Example

Example: POST /agent/run — create a new cloud agent run

Developer ToolsTerminalAI AgentsCloud AgentsAgentic Development

Warp Run Agent Example is an example object payload from Warp, with 3 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

descriptionrequestresponse

Example Payload

{
  "description": "Example: POST /agent/run — create a new cloud agent run",
  "request": {
    "method": "POST",
    "url": "https://app.warp.dev/api/v1/agent/run",
    "headers": {
      "Authorization": "Bearer wk-your-api-key",
      "Content-Type": "application/json"
    },
    "body": {
      "prompt": "Scan the repository for any TODO comments and create a GitHub issue summarizing them.",
      "mode": "normal",
      "title": "Scan for TODO comments",
      "team": true,
      "config": {
        "harness": {
          "repo": "my-org/my-repo",
          "branch": "main",
          "auth_secrets": {
            "github_token": "ghp_example_token"
          }
        }
      }
    }
  },
  "response": {
    "status": 200,
    "body": {
      "run_id": "run_01hzexample1234567890abcdef",
      "task_id": "run_01hzexample1234567890abcdef",
      "title": "Scan for TODO comments",
      "state": "queued",
      "prompt": "Scan the repository for any TODO comments and create a GitHub issue summarizing them.",
      "created_at": "2026-06-12T10:00:00Z",
      "updated_at": "2026-06-12T10:00:00Z",
      "source": "api",
      "session_link": "https://app.warp.dev/session/run_01hzexample1234567890abcdef",
      "conversation_id": "conv_01hzexample9876543210zyxwvu"
    }
  }
}