Skip to main content
POST
/
agents
/
tasks
/
{task_id}
/
subtasks
Create Subtask
curl --request POST \
  --url https://api.example.com/agents/tasks/{task_id}/subtasks \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "status": "backlog",
  "priority": 3,
  "assigned_to_type_id": "<string>",
  "assigned_to_instance_id": "<string>",
  "assigned_to_user_id": "<string>",
  "correlation_bucket_id": "<string>",
  "source": "manual"
}
'
import requests

url = "https://api.example.com/agents/tasks/{task_id}/subtasks"

payload = {
    "title": "<string>",
    "description": "<string>",
    "status": "backlog",
    "priority": 3,
    "assigned_to_type_id": "<string>",
    "assigned_to_instance_id": "<string>",
    "assigned_to_user_id": "<string>",
    "correlation_bucket_id": "<string>",
    "source": "manual"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    description: '<string>',
    status: 'backlog',
    priority: 3,
    assigned_to_type_id: '<string>',
    assigned_to_instance_id: '<string>',
    assigned_to_user_id: '<string>',
    correlation_bucket_id: '<string>',
    source: 'manual'
  })
};

fetch('https://api.example.com/agents/tasks/{task_id}/subtasks', 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/agents/tasks/{task_id}/subtasks",
  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' => 3,
    'assigned_to_type_id' => '<string>',
    'assigned_to_instance_id' => '<string>',
    'assigned_to_user_id' => '<string>',
    'correlation_bucket_id' => '<string>',
    'source' => 'manual'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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/agents/tasks/{task_id}/subtasks"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"backlog\",\n  \"priority\": 3,\n  \"assigned_to_type_id\": \"<string>\",\n  \"assigned_to_instance_id\": \"<string>\",\n  \"assigned_to_user_id\": \"<string>\",\n  \"correlation_bucket_id\": \"<string>\",\n  \"source\": \"manual\"\n}")

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

	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/agents/tasks/{task_id}/subtasks")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"backlog\",\n  \"priority\": 3,\n  \"assigned_to_type_id\": \"<string>\",\n  \"assigned_to_instance_id\": \"<string>\",\n  \"assigned_to_user_id\": \"<string>\",\n  \"correlation_bucket_id\": \"<string>\",\n  \"source\": \"manual\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/agents/tasks/{task_id}/subtasks")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"status\": \"backlog\",\n  \"priority\": 3,\n  \"assigned_to_type_id\": \"<string>\",\n  \"assigned_to_instance_id\": \"<string>\",\n  \"assigned_to_user_id\": \"<string>\",\n  \"correlation_bucket_id\": \"<string>\",\n  \"source\": \"manual\"\n}"

response = http.request(request)
puts response.read_body
{
  "title": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "description": "<string>",
  "status": "backlog",
  "priority": 3,
  "assigned_to_type_id": "<string>",
  "assigned_to_instance_id": "<string>",
  "assigned_to_user_id": "<string>",
  "correlation_bucket_id": "<string>",
  "created_by": "<string>",
  "source": "manual"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

​
task_id
string
required

Body

application/json

Request body for creating a task.

Attributes: title: Short description of the task. description: Detailed description. status: Initial task status. priority: Priority level (1=urgent, 2=high, 3=normal, 4=low). assigned_to_type_id: Agent type to assign. assigned_to_instance_id: Agent instance to assign. assigned_to_user_id: User to assign. correlation_bucket_id: Correlation bucket for related events. source: How this task was created.

​
title
string
required
​
description
string | null
​
status
enum<string>
default:backlog

Status of an agent task on the board.

Available options:
backlog,
assigned,
running,
review,
done
​
priority
integer
default:3
Required range: 1 <= x <= 4
​
assigned_to_type_id
string | null
​
assigned_to_instance_id
string | null
​
assigned_to_user_id
string | null
​
correlation_bucket_id
string | null
​
source
enum<string>
default:manual

Origin of an agent task.

Available options:
triage,
conversation,
manual

Response

Successful Response

An agent task representing a unit of work.

Tasks live inside each organization's SurrealDB namespace — the namespace is the organization boundary, so no per-record organization_id field is carried on the row.

Subtask relationships are modeled as has_subtask graph edges in SurrealDB rather than a flat parent reference. Use TaskStorageService graph traversal methods to find parents and children.

Attributes: id: SurrealDB record ID (populated by database). title: Short description of the task. description: Detailed description. status: Current task status. priority: Priority level (1=urgent, 2=high, 3=normal, 4=low). assigned_to_type_id: Agent type assigned to this task. assigned_to_instance_id: Agent instance working on this task. assigned_to_user_id: User assigned to this task. correlation_bucket_id: Correlation bucket for related events. created_by: User ID of the creator. source: How this task was created.

​
title
string
required
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
id
string | null
​
description
string | null
​
status
enum<string>
default:backlog

Status of an agent task on the board.

Available options:
backlog,
assigned,
running,
review,
done
​
priority
integer
default:3
Required range: 1 <= x <= 4
​
assigned_to_type_id
string | null
​
assigned_to_instance_id
string | null
​
assigned_to_user_id
string | null
​
correlation_bucket_id
string | null
​
created_by
string | null
​
source
enum<string>
default:manual

Origin of an agent task.

Available options:
triage,
conversation,
manual