Skip to content

Update a task

PUT
/api/v3/organizations/{organisation}/ai/tasks/{taskId}

Updates an existing task. All fields are optional - only provided fields will be updated. * * Status Transitions: * - Changing from pending to in_progress automatically sets startedAt timestamp * - Changing to completed, failed, or cancelled automatically sets completedAt timestamp * - Completed tasks get a 30-day TTL for automatic cleanup * * Progress Updates: * - Update progress (0.0 to 1.0) to track completion percentage * - Update progressMessage for human-readable status updates * - Set result object when task completes successfully * - Set error string when task fails

Authorizations

Parameters

Path Parameters

organisation
required
string

The organisation ID

taskId
required
string format: uuid

The task UUID

Example
550e8400-e29b-41d4-a716-446655440000

Request Body required

object
title
string
Updated task title
description
string
Updated description with more details
taskListId

Move task to different list or remove from list (set null)

string
nullable
world-2
status

Task status (triggers automatic timestamp updates)

string
Allowed values: pending in_progress completed failed cancelled
in_progress
assignedAgentId

Reassign task to different agent

string
nullable
agent-specialist
dependsOn

Update task dependencies

Array<string>
[
"550e8400-e29b-41d4-a716-446655440000"
]
metadata

Update task metadata (replaces entire metadata object)

object
{
"priority": "urgent"
}
progress

Progress from 0.0 to 1.0

number format: float
<= 1
0.75
progressMessage

Human-readable progress message

string
Processing document 3 of 4...
result

Task result data (set when completing task)

object
{
"summary": "Document processed successfully",
"wordCount": 1500
}
error

Error message (set when task fails)

string
nullable
Failed to connect to external API
retryCount

Update retry count

integer
1
maxRetries

Update maximum retry attempts

integer
<= 10
5

Responses

200

Task updated successfully

object
taskId
string format: uuid
status
string
updatedAt
integer

400

Invalid request

404

Task not found

500

Failed to update task