Skip to content

API reference

Meta

4 routes of the published API contract, generated from it.

GET/status

Auth: none

The same data rendered as a self-contained HTML page by the API itself.

Answer 200 · string · text/html

GET/v1/health

Auth: none

Liveness, and whether the service can start sandboxes. The cheapest call there is; use it as a readiness check.

Answer 200 · Health · application/json

build_shastring
The commit this build came from; empty for a local build. Answered to a caller with a key; absent for one without.
locationstring | null
Where sandboxes run, in plain words (for example "US East Coast"). Absent when the service does not say.
okrequiredboolean
readyboolean | null
Whether new sandboxes can start right now. Answered to a request made with a key; absent without one.
servingboolean | null
Whether the service can start new sandboxes right now.
versionrequiredstring
The API's version.

GET/v1/llms.txt

Auth: none

The agent guide as text/plain — the same document promigence agent-guide prints.

Answer 200 · string · text/plain

GET/v1/status

Auth: none

24 hours of synthetic check results plus service health, as JSON. This is what the status page reads.

Answer 200 · StatusSummary · application/json

checksrequiredCheckWindow
The last 24 hours of synthetic checks: totals, latency percentiles, fifteen-minute buckets and the most recent failures.
generated_atrequiredstring
RFC 3339.
servicerequiredstring
servicesrequiredServiceStatus[]
api, then sandboxes.
versionrequiredstring

Get started

Leave your work email and we will get you started.

See our Privacy Policy for how we use your email.