Skip to main content
PATCH

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Body

application/json
name
string
status
enum<string>

Only completed is accepted; it approves the task on behalf of the caller.

Available options:
completed
outputContent
object | null

Output changes, e.g. { "content": { "field": "new value" } }. Deep-merged into the existing output for Workstation/App tasks; replaces it for agent tasks.

tags
string[]

Replaces the task's tags (trimmed, de-duplicated).

Response

The updated task

id
string<uuid>
required
name
string
required
status
enum<string>
required

Task lifecycle status. created (agent tasks awaiting execution) → running → validating (output ready, awaiting review) → completed (approved). failed and cancelled are terminal.

Available options:
created,
running,
validating,
completed,
failed,
cancelled
createdBy
string
required

Email of the identity that created the task.

sourceType
enum<string>
required

Whether the task belongs to a Workstation/App (prompt) or to an agent (agent).

Available options:
prompt,
agent
workspaceId
string<uuid>
required
tags
string[]
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
reference
integer | null

Sequential number of the task within its app/agent. Assigned shortly after creation.

rawInput
Raw input · object | null

The completion request the task is executed with. Same shape as the /v2/chat/completions body; application_id is set by the server from promptApplicationId.

inputContent
Input content · object | null

Normalized input of the execution. null until the run has been prepared.

outputContent
object | null

Current output. For Canvas tasks this is the assistant message (role, content, …) where content holds the extracted fields; for workflow tasks it wraps { response, stepOutputs, error? }. Reflects reviewer edits.

originalOutputContent
object | null

Output as originally produced by the execution, before any reviewer edits.

approvedBy
string | null
approvedAt
string<date-time> | null
completionRunId
string<uuid> | null
workflowRunId
string<uuid> | null
agentId
string<uuid> | null
agentRef
string | null

Published agent identifier (agent tasks only).

agentSessionId
string | null
promptVersionId
string<uuid> | null

Canvas version the task was executed with (Workstation/App tasks only).

promptApplicationId
string<uuid> | null
metadata
Task metadata · object | null
deletedAt
string<date-time> | null
inputFiles
object[]

Only present on GET /task when excludeInputOutputColumns=true (and excludeInputFiles is not set). Summary of inputContent.files without parser payloads.