DocsReference

.md

Errors

All pages

Every error has the same body: a short code, and a detail that says what went wrong when there is more to say.

409 Conflict
{
  "error": "leased",
  "detail": "phone phone-1 is held by run run_5t1x"
}
StatusCodeMeans
400bad-requestThe body or query failed validation, or is over 1 MB. The detail names the field.
401unauthorizedThe key is missing, unknown or revoked.
402payment-requiredYour balance does not cover it. Adding phones needs a month of each monthly one, or 24 hours of each charged by the minute, and a phone cannot start while the balance is used up or short of the month it needs. Top up and try again.
403forbiddenThe key lacks the scope this route needs.
404not-foundNothing with that id in your workspace.
409leasedA run or another key holds the phone.
409busyThe phone already has two commands in flight. Wait for one to finish.
409preemptedSomeone took over the phone in the live view.
409not_runningThe phone is off.
409proxy-in-useA phone still goes out through the proxy you tried to remove.
422unprocessableThe request is well formed but cannot apply.
429throttledToo many requests. Wait as long as Retry-After says.
429budgetYour runs have used the day's model allowance.
503unavailableSomething the request needs is down for a moment. Retry with backoff.
503node_offlineThe machine the phone runs on cannot be reached.
503exits-exhaustedNo fresh exit is ready to rotate to. More are being vetted, so try again later. With reason: none-clean, the city you named has none, so pick another.
504timeoutThe phone did not answer in time.

An id that belongs to another workspace returns 404, the same as one that does not exist, so ids never reveal what other workspaces hold.

Something missing or unclear? Tell us and we will fix the page. The API also describes itself in OpenAPI.