Skip to main content
These hold across the whole API. Per-operation details live in the endpoint pages.

​
Errors

Errors follow a problem-details shape: type, title, status, detail, code, and request_id. Always log the request_id: it joins your failure to server-side traces, and support will ask for it.

​
Streaming

Streaming endpoints (chat, report generation, verification, imports) return server-sent events. Send:
Long-running operations take roughly 15–60 seconds. Set client timeouts to at least 120 seconds.

​
Pagination

Pagination fields are documented per-operation in the OpenAPI contract. Preserve the cursors and page fields an operation hands back rather than assuming a page shape.

​
Rate limits

Rate limiting returns 429. Retry with jitter and respect any retry headers.

​
Reading and writing the same keys

Request bodies take snake_case or connector-prefixed lowercase keys; responses render them camelCase. Reading a key off a GET and sending it straight back will fail. See Connectors for the concrete case.