Errors

Every API failure uses one JSON envelope.

{
  "error": {
    "code": "not_found",
    "message": "The requested resource was not found.",
    "request_id": "req_01K5A7R4WM9C2N6B8X3D"
  }
}

Branch on code, not message. Log request_id for support.

Status	Code	Action
400	`invalid_request`	Fix the request.
401	`unauthorized`	Send a valid API key.
402	`insufficient_credits`	Buy credits on the Billing page. The error has `balance` and `required`.
403	`analytics_not_enabled`	Enable analytics before reading this data.
404	`not_found`	Check the ID and workspace.
409	`conflict`	Fix the resource state, then retry if appropriate.
429	`rate_limited`	Wait for `Retry-After`, then retry.
500	`internal_error`	Retry with backoff.

If many requests return a 5xx status, check status.clipstake.com. It shows the current status of each ClipStake service. Resources outside the key’s workspace return 404. This does not confirm that the resource exists elsewhere. Send Content-Type: application/json with JSON mutations. An invalid content type can return 415 before the API creates an error envelope.

Getting Started

API Reference

Developer Guides