Skip to content
GurtOS docs

Get a task with its approvals and log

GET
/tasks/{id}
curl --request GET \
  --url http://127.0.0.1:7700/api/tasks/t3k9x2a1b2 \
  --header 'Authorization: Bearer <token>'

The task, every approval it asked for, and every action log event that belongs to it, in order.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

The task id.

Example 

t3k9x2a1b2

Responses

Section titled “Responses”

200

Section titled “200”

The task, its approvals and its events.

Media typeapplication/json
object
task
required
object
title
required

A short name for people.

string
prompt
required

What the worker should do. For the fake worker, one command per line.

string
workspace
required

A folder in BOX_HOME/workspaces. The task works on its own copy of it.

string
default: home /^[\w.-]+$/
worker
required

droid is Droid with Claude. fake runs scripted steps with no model, for tests.

string
default: droid
Allowed values: droid fake
tools
required

Tool names the task may call through its broker, such as wallet.pay.

Array<string>
default:
hosts
required

Hosts the task’s network may reach: example.com (any port), example.com:8080 (one port) or *.example.com (subdomains).

Array<string>
default:
budgetCents
required

Spending above this, in US cents, pauses the task for an OK. Default Settings defaultBudgetCents, 0 unless changed.

number
source
required

Who started it, for the log and the portal: api, schedule, asi1, jira:BOX-12.

string
default: api
folder

Personal: the first real folder the task works on a copy of.

string
folders

Personal: every real folder the task works on.

Array<string>
id
required
string
state
required

queued created, not started. running the worker is working. waiting paused until an approval is answered. done finished; its changes are part of the workspace. failed stopped with an error; its changes are not applied. undone removed; its changes are gone and other tasks keep theirs.

string
Allowed values: queued running waiting done failed undone
user
required

The Linux user the task runs as, box-<id>.

string
layers
required

Finished tasks whose changes this task saw when it started, newest first.

Array<string>
costCents
required

Tool spending plus model cost, in US cents. Not rounded.

number
step

The latest step

string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
error

Why it failed. A worker that exited with an error ends with its own last error line: worker exited with 1: Error: ....

string
summary
string
review

Personal, for a task on real folders: done and waiting for the owner, kept, stopped by a conflict, or undone.

string
Allowed values: pending kept conflict undone
approvals
required
Array<object>
object
id
required

<task id>.<key>. The same key asked twice is the same approval.

string
task
required
string
question
required

The question shown to people.

string
costCents
required

The spending being asked about

number
payee

Who gets paid

string
purpose

What the spend or action is for.

string
state
required
string
Allowed values: pending approved denied
by

Who answered: a paired device’s name, what the box’s own screen sent (such as box screen), jira:<name>, asi1, undo, or task ended.

string
events
required
Array
One of: discriminator: type

One line of the action log. See Log events.

object
seq
required

The line number in log.jsonl

integer
>= 1
at
required
string format: date-time
task
required

The task the event belongs to

string
type
required
Allowed value: task.created
spec
required

The spec with every default filled in.

object
title
required

A short name for people.

string
prompt
required

What the worker should do. For the fake worker, one command per line.

string
workspace

A folder in BOX_HOME/workspaces. The task works on its own copy of it.

string
default: home /^[\w.-]+$/
worker

droid is Droid with Claude. fake runs scripted steps with no model, for tests.

string
default: droid
Allowed values: droid fake
tools

Tool names the task may call through its broker, such as wallet.pay.

Array<string>
default:
hosts

Hosts the task’s network may reach: example.com (any port), example.com:8080 (one port) or *.example.com (subdomains).

Array<string>
default:
budgetCents

Spending above this, in US cents, pauses the task for an OK. Default Settings defaultBudgetCents, 0 unless changed.

number
source

Who started it, for the log and the portal: api, schedule, asi1, jira:BOX-12.

string
default: api
folder

Personal: the first real folder the task works on a copy of.

string
folders

Personal: every real folder the task works on.

Array<string>
user
required
string

Example 

{
  "task": {
    "workspace": "home",
    "worker": "droid",
    "tools": [],
    "hosts": [],
    "source": "api",
    "id": "t3k9x2a1b2",
    "state": "queued",
    "user": "box-t3k9x2a1b2",
    "review": "pending"
  },
  "approvals": [
    {
      "state": "pending"
    }
  ],
  "events": [
    {
      "type": "task.created",
      "spec": {
        "workspace": "home",
        "worker": "droid",
        "tools": [],
        "hosts": [],
        "source": "api"
      }
    }
  ]
}

400

Section titled “400”

No task with this id.

Media typeapplication/json
object
error
required

What went wrong

string

Example 

{
  "error": "no task t3k9x2a1b2"
}

GurtOS is open source under the Apache License 2.0.Source code on GitHub.