Skip to content

Create a new task

POST
/api/v3/organizations/{organisation}/ai/tasks

Creates a new task for multi-agent coordination and workflow orchestration. * * Key Features: * - Persistent State: Tasks survive across conversations and sessions * - Agent Assignment: Pre-assign tasks to specific agents * - Task Lists: Group related tasks using taskListId (implicit - no need to create lists first) * - Dependencies: Define task dependencies for workflow orchestration * - Metadata: Store flexible JSON metadata for task-specific data * - Progress Tracking: Track progress from 0.0 to 1.0 * * Use Cases: * - Break down complex requests into manageable steps * - Assign work to specialized agents * - Track long-running operations * - Coordinate multi-agent workflows

Authorizations

Parameters

Path Parameters

organisation
required
string

The organisation ID

Request Body required

object
title
required

Task title

string
Process document and create summary
description

Detailed task description

string
Extract text from PDF, analyze content, and generate executive summary
taskListId

Task list ID for grouping related tasks (implicit - lists are created automatically)

string
world-1
status

Initial task status

string
default: pending
Allowed values: pending in_progress completed failed cancelled
assignedAgentId

Pre-assign task to specific agent

string
agent-code-reviewer
createdByAgentId

Agent ID that created this task

string
agent-coordinator
dependsOn

Task IDs that must complete before this task can start

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

Flexible JSON metadata for task-specific data

object
{
"priority": "high",
"tags": [
"document-processing"
],
"workflow": "document-pipeline"
}
maxRetries

Maximum retry attempts on failure

integer
default: 3 <= 10

Responses

201

Task created successfully

object
taskId
string format: uuid
orgId
string
title
string
status
string
createdAt
integer

400

Invalid request

500

Failed to create task