Skip to main content
POST
Start a bot

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Bot identifier

Pattern: ^[1-9]\d*$
Example:

"12"

Response

config
BotConfig · object | null
required

Bot configuration, applied by the runner on its next poll; null when the stored configuration no longer matches the current schema and the bot must be recreated.

createdAt
string<date-time>
required

When the bot was created.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
id
string
required

Bot identifier.

Pattern: ^[1-9]\d*$
Example:

"12"

lastError
string | null
required

Why the bot halted, or null when it has never halted.

state
BotState · object | null
required

What the runner is doing with this bot: the pair it holds and the order it waits on; null while the bot is flat, has never run, or its stored state no longer matches the current schema.

status
enum<string>
required

running — the bot executes scheduled ticks. not_started — it has never been started, or you stopped it. halted — it hit a state it will not act on and stopped itself; lastError says which.

Available options:
halted,
not_started,
running
updatedAt
string<date-time>
required

When the bot last changed.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$