Skip to content
SupaCloud Docs
Select themeSelect language

get_api_tasks_id_

GET
/api/tasks/{id}
curl --request GET \
  --url https://example.com/api/tasks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie supacloud_session=<supacloud_session>

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Task id

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
agent_profile_id
required
string | null format: uuid
agent_profile_version
required
integer | null format: int32
agent_type
required
string
completed_at
required
string | null format: date-time
config
required
container_id
required
string | null
correlation_id
required
string | null format: uuid
cost_usd
required

Agent cost (USD) + token usage, folded in by the tasks-board handler from task_outcomes. None for a task with no recorded outcome and on endpoints that don’t join usage (From<Task> defaults them).

number | null format: double
created_at
required
string format: date-time
error_message
required
string | null
git_branch
required
string | null
group_id
required
string | null format: uuid
id
required
string format: uuid
input_tokens
required
integer | null format: int64
issue_id
required
string | null
issue_url
required
string | null
notes
required
string | null
output_tokens
required
integer | null format: int64
parent_task_id
required
string | null format: uuid
project_id
required
string | null format: uuid
prompt
required
string
session_id
required
string | null
started_at
required
string | null format: date-time
status
required

Task lifecycle status — an OPEN String, not a closed enum. The tasks.status column has no DB CHECK; its PRIMARY lifecycle is pending on create → starting/running → terminal completed/failed/cancelled. The wire type stays an unconstrained string on purpose: a value outside that set (a demo/seed state, or a future status) must render gracefully, never break the whole board. A closed-enum narrowing here made ONE unmodelled row fail the client contract validation and blank the entire Tasks list (ADR 0047 fail-loud is right for structural drift, wrong for an open evolving lexeme). The client maps known values to a tone/label + falls back to neutral for the rest.

string
summary
required

#538 — the (server-truncated) outcome summary, folded in by the tasks-board handler from task_outcomes; drives the per-task TL;DR. None for a task with no recorded summary and on endpoints that don’t join usage.

string | null
title
required
string
user_id
required
string format: uuid
Example
{
  "status": "running"
}

400

Section titled “400”

Structured client error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

401

Section titled “401”

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

403

Section titled “403”

Permission denied

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}