Skip to main content

API Standards

These standards keep API usage predictable and production-safe.

Request Format​

  • Content-Type: application/json for request bodies
  • Use UTF-8 encoded JSON
  • Send ISO 8601 timestamps in UTC

Idempotency​

For create operations, send an idempotency key.

Idempotency-Key: 0a6f617f-9a7e-4a48-9a3f-3952b53a5dd0

Retries with the same key should not create duplicate resources.

Pagination​

Cursor-based pagination is recommended for list endpoints.

GET /v1/posts?limit=25&cursor=cur_abc123

Response shape:

{
  "data": [],
  "paging": {
    "nextCursor": "cur_def456",
    "hasMore": true
  }
}

Versioning​

  • Major versions are path-based (/v1)
  • Breaking changes are introduced in a new major version
  • Non-breaking fields may be added without version bump
Last updated on