generated: '2026-10-18'
method: searched
generator: extract-docs-artifacts.py (local)
source: https://www.nimbusnexus.net/docs/conventions
sources:
- https://www.nimbusnexus.net/docs/conventions
- https://www.nimbusnexus.net/docs/pagination
- https://www.nimbusnexus.net/docs/rate-limiting
- https://www.nimbusnexus.net/docs/product-webhooks/signatures
idempotency:
  coverage: full
  header: Idempotency-Key
  retention: 24 hours
  evidence: Mutating endpoints (POST, PUT, PATCH, DELETE) accept an optional Idempotency-Key header. Pass any unique value (a UUID is conventional);
    we cache the response for 24 hours and return the same response on a repeat with the same key.
pagination:
  style: cursor
  params:
  - limit
  - cursor
  response_fields:
  - items
  - pagination.next_cursor
  - pagination.total_count
error_envelope: All error responses use a JSON shape with an "error" object containing "code", "message", optional "details", and "request_id".
request_tracing: Every error body includes a "request_id" that matches the X-Request-ID response header.
rate_limit_signaling: Headers X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-RateLimit-Window are sent on every response.
docs: https://www.nimbusnexus.net/docs/conventions