Back to API Reference

Runs API

POST/agents/:id/runs

Start a new agent run

{
  "input": "Help me find a product",
  "sessionId": "session_123",
  "stream": false,
  "metadata": { "userId": "user_456" }
}
GET/runs

List all runs with optional filters

Query Parameters

  • agentId - Filter by agent
  • status - running, completed, failed
  • limit - Max results (default 20)
  • cursor - Pagination cursor
GET/runs/:id

Get run details and status

Response

{
  "id": "run_abc123",
  "agentId": "agent_xyz",
  "status": "completed",
  "input": "Help me find a product",
  "output": "I found several products...",
  "steps": [...],
  "usage": { "totalTokens": 1500 },
  "duration": 2340,
  "createdAt": "2024-01-15T10:30:00Z"
}
POST/runs/:id/cancel

Cancel a running execution