Smart Agent Teams
EndpointsTasks

Get Task

Get one task by reference. `task_ref` is the task's UUID or its key, e.g. `SAT-12` (the prefix is matched case-insensitively). Answers 404 `NOT_FOUND` when no task matches.

GET
/api/companies/{company_id}/tasks/{task_ref}

Get one task by reference.

task_ref is the task's UUID or its key, e.g. SAT-12 (the prefix is matched case-insensitively). Answers 404 NOT_FOUND when no task matches.

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

task_ref*Task Ref
company_id*Company Id
Formatuuid

Response Body

Successful Response

application/json
  1. response
assignee_agent_id*|null
completed_at*|null
created_at*|null
created_by_agent_id*|null
created_by_user_id*|null
description*string|null
due_date*|null
goal_id*|null
id*Id
Formatuuid
key*Key
number*Number
parent_id*|null
priority*Priority
project_id*|null
sort_order*Sort Order
started_at*|null
status*Status
title*Title
updated_at*|null
curl -X GET "https://example.com/api/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/tasks/string"
{  "assignee_agent_id": "8ff43445-51ff-4235-b9d4-d8007d4d5dc3",  "completed_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "created_by_agent_id": "acd3b99b-57bd-46a1-809a-5d915f3c2609",  "created_by_user_id": "209f54c4-4c33-43bc-9c6a-ef4c65ad7473",  "description": "string",  "due_date": "2019-08-24T14:15:22Z",  "goal_id": "3854d9ad-4bca-4a70-a63e-7c6bc2f12aee",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "key": "string",  "number": 0,  "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",  "priority": "string",  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",  "sort_order": 0,  "started_at": "2019-08-24T14:15:22Z",  "status": "string",  "title": "string",  "updated_at": "2019-08-24T14:15:22Z"}

Create Task POST

Create a task with the next per-company number and key (e.g. `SAT-12`). Referenced assignee, project, goal and parent must belong to this company (404 `NOT_FOUND` otherwise). If the assignee is available (not `paused`, `pending_approval` or `terminated`) and the status is not `backlog`, `done` or `cancelled`, an `assignment` run is queued for it. A runner acting for an agent passes `run_id` of its running run (400 `RUN_NOT_RUNNING` otherwise) and the task is attributed to that agent. Publishes `task.created` (and `run.created`).

Update Task PATCH

Update a task; only fields present in the body are changed. `task_ref` is the task's UUID or key (e.g. `SAT-12`). Moving to `in_progress` stamps `started_at`; moving to `done` stamps `completed_at`, and leaving `done` clears it. Reassigning to an available agent queues an `assignment` run, under the same rules as creation. Setting `parent_id` to the task itself is ignored. Pass `run_id` to act as a running run's agent (400 `RUN_NOT_RUNNING`). Publishes `task.updated` (and `run.created`) only when something changed.