Get a playbook run

GET

/projects/:projectId/playbook-runs/:runId

GET

/projects/:projectId/playbook-runs/:runId

1 curl https:/https://api/projects/projectId/playbook-runs/runId \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

1 {
2   "run": {
3     "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
4     "projectId": "proj_9876543210",
5     "status": "completed",
6     "startedAt": "2024-06-10T09:15:00Z",
7     "finishedAt": "2024-06-10T09:45:00Z",
8     "triggeredBy": "user_123456",
9     "steps": [
10       {
11         "stepId": "step_001",
12         "name": "Initialize playbook",
13         "status": "success",
14         "startedAt": "2024-06-10T09:15:00Z",
15         "finishedAt": "2024-06-10T09:17:00Z"
16       },
17       {
18         "stepId": "step_002",
19         "name": "Run AI agent",
20         "status": "success",
21         "startedAt": "2024-06-10T09:17:00Z",
22         "finishedAt": "2024-06-10T09:40:00Z"
23       },
24       {
25         "stepId": "step_003",
26         "name": "Notify team",
27         "status": "success",
28         "startedAt": "2024-06-10T09:40:00Z",
29         "finishedAt": "2024-06-10T09:45:00Z"
30       }
31     ],
32     "metadata": {
33       "environment": "production",
34       "priority": "high"
35     }
36   }
37 }

Returns a single playbook run by id.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Path parameters

projectIdstringRequired

runIdstringRequired

Response

The playbook run.

runmap from strings to any

A playbook run projection.

Errors

401

Unauthorized Error

404

Not Found Error