API Reference

Errors

Every error has the same shape, a stable type and a readable message.

Error shape

json

{
  "error": {
    "type": "not_found",
    "message": "Matter not found"
  }
}

Branch on type; show message to people. Messages can change, but types won't.

Status	`type`	Meaning	What to do
`400`	`invalid_request`	A parameter or body field is missing, the wrong type or out of range. The message names the field.	Fix the request. Don't retry it unchanged.
`401`	`authentication_required`	No API key, or an invalid, revoked or expired one, or a browser session instead of a key	Send a valid key.
`403`	`permission_denied`	The key's role can't use the API (client and external accounts)	Use a staff account's key.
`404`	`not_found`	The matter or document doesn't exist, or the caller can't access it. Also any unknown path under `/api/v1`.	Check the ID, and the user's access.
`429`	`rate_limited`	Too many requests from one key	Wait for `Retry-After` seconds, then retry.
`500`	`server_error`	Something went wrong on Sentinel's side	Retry with backoff. If it persists, contact support with the time and endpoint.

GET requests and search are read-only, so they're always safe to retry. Back off exponentially on 429 and 500. See Rate limits.