Tasks
Work items, their review flow, and the routines and autopilot that do them.
List tasks
Beta — this operation may change on 30 days notice. See versioning.
Returns the workspace's tasks. Templates are hidden unless task_is_template asks for them.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
query Parameters
cursor^[A-Za-z0-9_-]+$limitoffsetsort^-?[a-z0-9_]+$task_assigned_totask_autopilot_onlytask_created_bytask_descriptiontask_is_templatetask_nametask_prioritytask_routines_onlytask_statustask_workflow_onlyHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List tasks › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
Create a task
Beta — this operation may change on 30 days notice. See versioning.
Creates a task. To create one from a saved template, use POST /tasks/{id}/copy.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Create a task › Responses
Created
task_idtask_numbertask_nametask_descriptiontask_statustask_prioritytask_assigned_totask_assigned_attask_created_bytask_due_attask_formtask_datatask_copilottask_wftask_wf_instancetask_wf_steptask_callback_urltask_is_templatetask_activetask_createdtask_updatedGet a task
Beta — this operation may change on 30 days notice. See versioning.
Returns the task with its status, its owner and where it has got to in review.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get a task › Responses
Success
task_idtask_numbertask_nametask_descriptiontask_statustask_prioritytask_assigned_totask_assigned_attask_created_bytask_due_attask_formtask_datatask_copilottask_wftask_wf_instancetask_wf_steptask_callback_urltask_is_templatetask_activetask_createdtask_updatedDelete a task
Beta — this operation may change on 30 days notice. See versioning.
Deactivates the task. It stops being listed; its history and its thread are kept.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Delete a task › Responses
Success. No content.
Update a task
Beta — this operation may change on 30 days notice. See versioning.
Applies the task_-prefixed fields present in the body. Moving a task through review goes through the review endpoints, which record who decided what.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Update a task › Responses
Success
task_idtask_numbertask_nametask_descriptiontask_statustask_prioritytask_assigned_totask_assigned_attask_created_bytask_due_attask_formtask_datatask_copilottask_wftask_wf_instancetask_wf_steptask_callback_urltask_is_templatetask_activetask_createdtask_updatedApprove or reject a task
Beta — this operation may change on 30 days notice. See versioning.
The creator's half of review. approved: true completes it; false sends it back in progress with your comments attached.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Approve or reject a task › Responses
Success
Create from a template
Beta — this operation may change on 30 days notice. See versioning.
Clones a template into a real task. The body may override who it is assigned to, its name, due date and priority.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Create from a template › Responses
Success
Change the schedule
Beta — this operation may change on 30 days notice. See versioning.
Enable, disable or reschedule it. Accepts a cron expression and timezone, and optionally an end date or a maximum number of runs.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Change the schedule › Responses
Success
Run autopilot
Beta — this operation may change on 30 days notice. See versioning.
Runs a model — it consumes credits and counts against the expensive rate-limit tier.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Run autopilot › Responses
Success
Email the response
Beta — this operation may change on 30 days notice. See versioning.
Emails the task's response to a recipient, for the tasks whose output is meant to leave the platform.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Email the response › Responses
Success
Submit for review
Beta — this operation may change on 30 days notice. See versioning.
The assignee's half of review. The task moves to awaiting review rather than to done.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Submit for review › Responses
Success
List autopilot runs
Beta — this operation may change on 30 days notice. See versioning.
Returns what autopilot has done recently and to which tasks — the record behind the work nobody asked for by hand.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List autopilot runs › Responses
Success
Generate the briefing
Beta — this operation may change on 30 days notice. See versioning.
Builds it on demand instead of waiting for the scheduled run.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Generate the briefing › Responses
Success
Get today's briefing
Beta — this operation may change on 30 days notice. See versioning.
The morning summary of what is waiting, as shown on the dashboard.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get today's briefing › Responses
Success
Enrich a brief
Beta — this operation may change on 30 days notice. See versioning.
Runs a model — it consumes credits and counts against the expensive rate-limit tier.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Enrich a brief › Responses
Success
Stream task events
Beta — this operation may change on 30 days notice. See versioning.
A server-sent event stream of changes across the workspace. Responds with text/event-stream.
Pair it with slow polling rather than relying on it alone: the event bus is per-instance and in memory, so a reconnection can land somewhere that missed an event.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Stream task events › Responses
Success
List routines
Beta — this operation may change on 30 days notice. See versioning.
The task templates set to run on a schedule.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List routines › Responses
Success
task_idtask_numbertask_nametask_descriptiontask_statustask_prioritytask_assigned_totask_assigned_attask_created_bytask_due_attask_formtask_datatask_copilottask_wftask_wf_instancetask_wf_steptask_callback_urltask_is_templatetask_activetask_createdtask_updatedCreate a routine
Beta — this operation may change on 30 days notice. See versioning.
Takes what was worked out in a thread and makes it a task template that can run on a schedule.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Create a routine › Request Body
thread_idinstructionschedule_hintmessage_idCreate a routine › Responses
Success
Run a routine now
Beta — this operation may change on 30 days notice. See versioning.
Runs it immediately without affecting its schedule.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Run a routine now › Responses
Success
Get task statistics
Beta — this operation may change on 30 days notice. See versioning.
Counts by status and by owner, for a dashboard rather than a listing.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get task statistics › Responses
Success
List suggested routines
Beta — this operation may change on 30 days notice. See versioning.
Work the caller repeats often enough that it could run on a schedule instead.
Requires the module-tasks license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List suggested routines › Responses
Success