Claim a task

POST

/projects/:projectId/playbook-runs/:runId/tasks/:taskId/claim

POST

/projects/:projectId/playbook-runs/:runId/tasks/:taskId/claim

1 curl -X POST https:/https://api/projects/projectId/playbook-runs/runId/tasks/taskId/claim \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

1 {
2   "task": {
3     "id": "task_9f8b7c6d-1234-4e56-8a9b-0c1d2e3f4a5b",
4     "status": "claimed",
5     "claimedBy": "user_42a1b3c4-d567-4e89-9f01-23456789abcd",
6     "claimedAt": "2024-06-10T15:20:30Z",
7     "title": "Review contract draft",
8     "description": "Please review the latest draft of the contract and provide feedback.",
9     "dueDate": "2024-06-15T23:59:59Z",
10     "priority": "high",
11     "metadata": {
12       "playbookRunId": "run_123e4567-e89b-12d3-a456-426614174000",
13       "projectId": "proj_987f6543-21ab-4cde-8f90-123456789abc"
14     }
15   }
16 }

Claims an available human task for the caller.

Authentication

AuthorizationBearer

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

Path parameters

projectIdstringRequired

runIdstringRequired

taskIdstringRequired

Response

The claimed task state.

taskmap from strings to any

An arbitrary JSON object.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error