Create a task

Add a brand-new task to the project. This only ever adds: it never overwrites existing data, and the new task shows up in the product like any other.

Example: “Create a task titled ‘Write Q3 launch brief’”

Usage: give the new task a title (the only required field). You can also set its description, status, priority, due date, assignee, parent task (to make it a subtask), labels, and any files to attach on creation.

Response: the created task, including its generated id and identifier along with the status, priority, assignee, and other fields it was created with.

POST /api/v1/business/tasks

Create a task

cURL

curl --request POST \
  --url https://api.example.com/api/v1/business/tasks \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "status": "backlog",
  "priority": "none",
  "assignee_type": "system",
  "assignee_id": "<string>",
  "parent_task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "page_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source": "user",
  "due_date": "2023-12-25",
  "label_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "settings_override": {},
  "attachments": [
    {
      "attachment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "filename": "<string>",
      "content_type": "<string>"
    }
  ]
}
'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "identifier": "<string>",
  "title": "<string>",
  "description": "<string>",
  "status": "backlog",
  "priority": "urgent",
  "creator_type": "human",
  "creator_id": "<string>",
  "assignee_type": "human",
  "assignee_id": "<string>",
  "parent_task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "page_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "due_date": "2023-12-25",
  "sort_order": 123,
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "comment_count": 123,
  "last_comment_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Headers

x-project-id · string<uuid> · required

Project ID for tenant scoping

X-Workspace-Id · string<uuid> | null

Overrides the key's workspace

X-API-Key · string | null

User API key

Body

application/json

title · string · required

Task title.

Required string length: 1 - 500

description · string | null

Task body/details.

status · enum<string> · default: backlog

Initial task status.

Available options: backlog, todo, in_progress, pending_human_approval, in_review, done, cancelled

priority · enum<string> · default: none

Task priority.

Available options: urgent, high, medium, low, none

assignee_type · enum<string> · default: system

Whether the assignee is a human user or an agent.

Available options: human, ai_agent, system

assignee_id · string | null

Required unless assignee_type is system - the user id for human, or the agent's UUID (as a string) for ai_agent.

parent_task_id · string<uuid> | null

Parent task, to create this as a subtask.

page_id · string<uuid> | null

Content-intelligence page this task relates to, if any.

source · enum<string> · default: user

Source of the task.

Available options: user, agent, content_intelligence

due_date · string<date> | null

Due date for the task.

label_ids · string<uuid>[]

Labels to attach to the task.

settings_override · Settings Override · object

Per-task overrides of project-level agent settings. Value per key: for skip_review, one of ReviewMode (require_review, auto_approve, defer) - not a bool; for gated_tools/gated_capabilities, a dict of tool/capability NAME (not id) -> bool - keys are resolved by name against active tool/capability rows.

attachments · PendingAttachment · object[]

Files to attach to the task on creation.

Show child attributes

Response

200

application/json

Successful Response

id · string<uuid> · required

project_id · string<uuid> · required

identifier · string · required

title · string · required

description · string | null · required

status · enum<string> · required

Available options: backlog, todo, in_progress, pending_human_approval, in_review, done, cancelled

priority · enum<string> · required

Available options: urgent, high, medium, low, none

creator_type · enum<string> · required

Available options: human, ai_agent, system

creator_id · string | null · required

assignee_type · enum<string> · required

Available options: human, ai_agent, system

assignee_id · string | null · required

parent_task_id · string<uuid> | null · required

page_id · string<uuid> | null · required

schedule_id · string<uuid> | null · required

due_date · string<date> | null · required

sort_order · number · required

started_at · string<date-time> | null · required

completed_at · string<date-time> | null · required

comment_count · integer · required

last_comment_at · string<date-time> | null · required

created_at · string<date-time> · required

updated_at · string<date-time> · required