First-run setup state

GET

/setup

const url = 'http://127.0.0.1:7700/api/setup';
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/setup \
  --header 'Authorization: Bearer <token>'

Until done is true, the box’s own screen shows the setup steps. A box that already ran tasks when setup arrived is migrated and counts as done. modelKey is false until the vault holds a model key; without one no Droid task can start. suggested lists the usual step ids in order. The box accepts any id.

Authorizations

deviceToken
accessToken

Responses

200

The setup state.

application/json

object

model

Whether tasks can run: the vault holds a model key. via is factory with FACTORY_API_KEY, anthropic with only ANTHROPIC_API_KEY, or null with neither.

object

ready

boolean

via

string | null

Allowed values: factory anthropic

droid

Where the Droid download stands. A task that needs Droid waits, queued, until ready.

object

state

required

string

Allowed values: ready downloading offline retrying missing

message

required

string

modelKey

False until the vault holds a model key. Without one no Droid task can start.

boolean

done

required

boolean

finishedAt

string | null format: date-time

migrated

The box already ran tasks when setup arrived

boolean

steps

required

object

key

additional properties

object

string format: date-time

data

suggested

required

The usual step ids, in order. Server’s screen skips folders, and Personal’s skips network, name and updates. The box accepts any id.

Array<string>

channel

The setup port for setting up from another computer.

object

open

required

boolean

until

When the port closes by itself.

string format: date-time

port

integer

urls

The addresses another computer can use.

Array<string>

remote

The box’s remote access address

string

devices

Array<object>

object

name

string

since

string format: date-time

Example

{
  "model": {
    "via": "factory"
  },
  "droid": {
    "state": "ready"
  },
  "suggested": [
    "welcome",
    "network",
    "name",
    "phone",
    "models",
    "folders",
    "safety",
    "updates"
  ]
}