Skip to main content
GET
/
agents
/
tasks
/
{task_id}
Get Task
curl --request GET \
  --url https://api.example.com/agents/tasks/{task_id}
import requests

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

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/agents/tasks/{task_id}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/agents/tasks/{task_id}")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)

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

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