API conventions

Pagination#

Collection endpoints use cursor-based pagination when result sets can grow materially over time. Responses include an opaque cursor token for the next page and stable ordering guarantees for deterministic sync loops.

GET /v1/pqc/inventory?limit=100&cursor=eyJvZmZzZXQiOjEwMH0=
{
  "items": [...],
  "nextCursor": "eyJvZmZzZXQiOjIwMH0=",
  "hasMore": true
}

Idempotency for writes#

For mutation endpoints, include Idempotency-Key to guarantee replay-safe behavior when clients retry after network interruptions.

Request and response headers#

Content types#

• Default request and response media type is application/json; charset=utf-8.
• File uploads use multipart/form-data when documented on the endpoint.
• Report exports may return binary content with explicit Content-Type and Content-Disposition headers.

Retries and backoff#