Read the action log

GET

/log

const url = 'http://127.0.0.1:7700/api/log?after=0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://127.0.0.1:7700/api/log?after=0' \
  --header 'Authorization: Bearer <token>'

Log events after a cursor, optionally for one task. Pass the last seq you saw as after to read only what is new.

Authorizations

deviceToken
accessToken

Parameters

Query Parameters

after

integer

Return events with a seq greater than this. Default 0, the whole log.

task

string

Only events of this task.

Responses

200

The events, in order.

application/json

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

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

One line of the action log. See Log events.

object

seq

required

The line number in log.jsonl

integer

>= 1

required

string format: date-time

task

required

The task the event belongs to

string

type

required

Allowed value: task.state

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

layers

Array<string>

error

string

summary

string

One line of the action log. See Log events.

object

seq

required

The line number in log.jsonl

integer

>= 1

required

string format: date-time

task

required

The task the event belongs to

string

type

required

Allowed value: task.step

text

required

string

data

What the worker needs to resume.

One line of the action log. See Log events.

object

seq

required

The line number in log.jsonl

integer

>= 1

required

string format: date-time

task

required

The task the event belongs to

string

type

required

Allowed value: tool.call

key

required

string

tool

required

string

input

required

One line of the action log. See Log events.

object

seq

required

The line number in log.jsonl

integer

>= 1

required

string format: date-time

task

required

The task the event belongs to

string

type

required

Allowed value: tool.result

key

required

string

required

boolean

output

error

string

cents

What the call spent. Counts toward the task’s cost.

number

One line of the action log. See Log events.

object

seq

required

The line number in log.jsonl

integer

>= 1

required

string format: date-time

task

required

The task the event belongs to

string

type

required

Allowed value: approval.asked

approval

required

object

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

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

One line of the action log. See Log events.

object

seq

required

The line number in log.jsonl

integer

>= 1

required

string format: date-time

task

required

The task the event belongs to

string

type

required

Allowed value: approval.answered

required

string

approved

required

boolean

required

string

One line of the action log. See Log events.

object

seq

required

The line number in log.jsonl

integer

>= 1

required

string format: date-time

task

The task the event belongs to

string

type

required

Allowed value: cost

cents

required

number

what

required

string

model

string

tokens

object

input

required

integer

output

required

integer

cacheWrite

required

integer

cacheRead

required

integer

One line of the action log. See Log events.

object

seq

required

The line number in log.jsonl

integer

>= 1

required

string format: date-time

task

required

The task the event belongs to

string

type

required

Allowed value: net.blocked

host

required

host:port the task tried to reach.

string

One line of the action log. See Log events.

object

seq

required

The line number in log.jsonl

integer

>= 1

required

string format: date-time

task

required

The task the event belongs to

string

type

required

Allowed value: keep

result

required

string

Allowed values: pending kept conflict reverted

changes

Array<object>

object

path

required

Path inside the workspace.

string

change

required

string

Allowed values: added modified deleted

conflicts

Array<string>

One line of the action log. See Log events.

object

seq

required

The line number in log.jsonl

integer

>= 1

required

string format: date-time

task

The task the event belongs to

string

type

required

Allowed value: note

track

required

The app that wrote the note.

string

data

required

Example

[
  {
    "type": "task.created",
    "spec": {
      "workspace": "home",
      "worker": "droid",
      "tools": [],
      "hosts": [],
      "source": "api"
    }
  }
]

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