Where Quick Start stands

GET

/quickstart

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

Owner only. state is off when none was started.

Authorizations

deviceToken
accessToken

Responses

200

The state.

application/json

object

state

required

string

Allowed values: off waiting applying done stopped error

phrase

Four words to compare on both screens.

string

steps

required

What was applied

Array<string>

error

string

expiresAt

string format: date-time

Example

{
  "state": "off"
}

403

The owner’s route, called by someone who is not the box’s own screen or a device paired as the owner.

application/json

object

error

required

What went wrong

string

Example

{
  "error": "only this computer's own screen or the owner's paired device can do this"
}