API reference Using the API

Errors

Every error has the same body. Branch on code, which is stable; message is written for people and may change.

401 Unauthorized

{
  "error": {
    "code": "unauthorized",
    "message": "authentication required"
  }
}

Status codes

Status	`code`	When
`400`	`bad_request`, or the route's own	The request or its filter is malformed.
`401`	`unauthorized`	No key, or a key that is revoked or expired.
`403`	`forbidden`, `api_key_route`, or the route's own	The key's role cannot do this, or the route is not one a key may call.
`404`	`not_found`	No such object in this workspace.
`409`	`conflict`, or the route's own	The change conflicts with the object's current state.
`500`	`internal`	Something failed on our side. The message says no more than that.

Each operation's page lists the statuses that route can answer, and why.