Sample documentation page (fictional product, used by the DocsChat demo)
Errors
Nimbus uses conventional HTTP status codes. Errors return a JSON body with a machine-readable code and a human-readable message.
{ "error": { "code": "invalid_payload", "message": "data must be a JSON object" } }
Status codes
400invalid_payload: the request body is malformed or fails validation.401unauthorized: the API key is missing, wrong or deleted.403forbidden: the key is valid but lacks the required permission (for example a restricted key).404not_found: the resource does not exist.409duplicate_event: an event with the same idempotency key was already accepted.413payload_too_large: the event is larger than 256 KB.429rate_limited: too many requests. See rate limits.500and503: a problem on our side. Retry with backoff and check the status page.
Idempotency
Send an Idempotency-Key header (any unique string up to 64 characters) so retrying a request never creates a duplicate event. Keys are remembered for 24 hours.