Create a task

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>"
    }
  ]
}
'

import requests

url = "https://api.example.com/api/v1/business/tasks"

payload = {
    "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>"
        }
    ]
}
headers = {
    "x-project-id": "<x-project-id>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-project-id': '<x-project-id>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>'
      }
    ]
  })
};

fetch('https://api.example.com/api/v1/business/tasks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/business/tasks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-project-id: <x-project-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/business/tasks"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"backlog\",\n  \"priority\": \"none\",\n  \"assignee_type\": \"system\",\n  \"assignee_id\": \"<string>\",\n  \"parent_task_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"page_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"source\": \"user\",\n  \"due_date\": \"2023-12-25\",\n  \"label_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"settings_override\": {},\n  \"attachments\": [\n    {\n      \"attachment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"filename\": \"<string>\",\n      \"content_type\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-project-id", "<x-project-id>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/business/tasks")
  .header("x-project-id", "<x-project-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"backlog\",\n  \"priority\": \"none\",\n  \"assignee_type\": \"system\",\n  \"assignee_id\": \"<string>\",\n  \"parent_task_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"page_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"source\": \"user\",\n  \"due_date\": \"2023-12-25\",\n  \"label_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"settings_override\": {},\n  \"attachments\": [\n    {\n      \"attachment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"filename\": \"<string>\",\n      \"content_type\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/business/tasks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-project-id"] = '<x-project-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"backlog\",\n  \"priority\": \"none\",\n  \"assignee_type\": \"system\",\n  \"assignee_id\": \"<string>\",\n  \"parent_task_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"page_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"source\": \"user\",\n  \"due_date\": \"2023-12-25\",\n  \"label_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"settings_override\": {},\n  \"attachments\": [\n    {\n      \"attachment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"filename\": \"<string>\",\n      \"content_type\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

api

business

tasks

Create a task

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>"
    }
  ]
}
'

import requests

url = "https://api.example.com/api/v1/business/tasks"

payload = {
    "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>"
        }
    ]
}
headers = {
    "x-project-id": "<x-project-id>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-project-id': '<x-project-id>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>'
      }
    ]
  })
};

fetch('https://api.example.com/api/v1/business/tasks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/business/tasks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-project-id: <x-project-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/business/tasks"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"backlog\",\n  \"priority\": \"none\",\n  \"assignee_type\": \"system\",\n  \"assignee_id\": \"<string>\",\n  \"parent_task_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"page_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"source\": \"user\",\n  \"due_date\": \"2023-12-25\",\n  \"label_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"settings_override\": {},\n  \"attachments\": [\n    {\n      \"attachment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"filename\": \"<string>\",\n      \"content_type\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-project-id", "<x-project-id>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/business/tasks")
  .header("x-project-id", "<x-project-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"backlog\",\n  \"priority\": \"none\",\n  \"assignee_type\": \"system\",\n  \"assignee_id\": \"<string>\",\n  \"parent_task_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"page_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"source\": \"user\",\n  \"due_date\": \"2023-12-25\",\n  \"label_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"settings_override\": {},\n  \"attachments\": [\n    {\n      \"attachment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"filename\": \"<string>\",\n      \"content_type\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/business/tasks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-project-id"] = '<x-project-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"backlog\",\n  \"priority\": \"none\",\n  \"assignee_type\": \"system\",\n  \"assignee_id\": \"<string>\",\n  \"parent_task_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"page_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"source\": \"user\",\n  \"due_date\": \"2023-12-25\",\n  \"label_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"settings_override\": {},\n  \"attachments\": [\n    {\n      \"attachment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"filename\": \"<string>\",\n      \"content_type\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

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

Successful Response

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

⌘I

Getting Started

Identity & Project

Tasks

Agent Runs

Playbooks

Grids

Knowledge & Brand

Content Intelligence

Integrations & Attachments

Create a task

Headers

Body

Response