Operating system set to macOS
Documentation jurisdiction set to United States
Sign inConnect Claude
API/schemas
Schema

TaskResponse

Task response model.

FieldTypeDescription
idrequiredstring (uuid)Task UUID
permakeystring | nullStable human-readable task/instance key for the nested deep-link URL .../cycles/{cycle}/instance/{permakey}. Null on legacy rows.
cycle_idrequiredstring (uuid)Parent cycle UUID
step_idstring | nullBlueprint step id this task corresponds to (FE OutputsViewer resolver)
step_indexrequiredintegerStep index in workflow
namerequiredstringTask name
typerequiredstringTask type (domain type for display: extraction, validation, etc.)
statusrequired"pending" | "planning" | "pending_approval" | "upload_document" | "running" | "paused" | "blocked" | "awaiting_approval" | "approved" | "rejected" | "done" | "completed" | "failed" | "skipped"Status for individual tasks. Database constraint: pending, running, paused, blocked, done, skipped, failed Additional API statuses: planning, pending_approval, awaiting_approval, approved, rejected, completed
pendingplanningpending_approvalupload_documentrunningpausedblockedawaiting_approvalapprovedrejecteddonecompletedfailedskipped
requires_approvalbooleanWhether task requires approval
input_dataobjectTask input
show nested
Empty object.
output_dataobjectTask output
show nested
Empty object.
error_messagestring | nullError message if failed
started_atstring (date-time) | nullStart timestamp
completed_atstring (date-time) | nullCompletion timestamp
approved_bystring (uuid) | nullApprover user ID
approved_atstring (date-time) | nullApproval timestamp
created_atrequiredstring (date-time)Creation timestamp
updated_atrequiredstring (date-time)Last update timestamp
cost_centsinteger | nullReal compute (token) cost of this step in pence. NULL/0 for seed/notify steps.
cost_gbpnumber | nullReal compute cost of this step in GBP (cost_cents / 100). NULL when no cost.
reasoning_summarystring | nullThe step's reasoning trace summary (workstreams.task.thinking_summary). NULL on older cycles or steps that recorded no reasoning.
tokens_inputinteger | nullInput tokens consumed by this step. NULL on legacy rows.
tokens_outputinteger | nullOutput tokens produced by this step. NULL on legacy rows.