Skip to main content
POST
Request the next work assignment

Authorizations

Authorization
string
header
required

Runner token beginning with agt_r, returned once by POST /v1/runners

Body

application/json

Runner's request for work. Lists held fleet sandboxes to prefer their next events; an empty list may be omitted. Accepted work kinds are required.

accepted_kinds
enum<string>[]
required

The nonempty set of work protocols implemented by this worker.

Required array length: 1 - 2 elements

The two independent work domains sharing a physical host's workers.

Available options:
fleet,
authoring
holds
string[]

Every fleet this runner holds a frozen sandbox for. Absent decodes as empty.

Maximum array length: 64
Required string length: 36

Response

A lease to run, or a backoff to wait out

POST /v1/runners/me/leases reply. Always 200.

lease is the work, or null with retry_after_ms set when there is none — a backoff hint rather than a 204.

lease
object

The work, when there is any.

retry_after_ms
integer<int32> | null

How long to wait before asking again, when there is none.

Required range: x >= 0