New API v1 Release: What We’re Standardizing (and Why)

API v1 is about consistency: predictable endpoints, clear errors, stable versioning, and documentation that stays accurate.

Our API principles

  • Contract-first docs: we document the API using OpenAPI so clients can generate SDKs and validate requests.
  • HTTP semantics: status codes and caching behavior should follow the standard.
  • Auth done right: token-based flows built on OAuth 2.0 patterns.

References worth bookmarking: OpenAPI 3.1, RFC 9110 (HTTP Semantics), and RFC 6749 (OAuth 2.0).

What’s in v1

  • Versioned base path (/api/v1) and stable resource naming
  • Consistent error envelope (machine-readable codes + human messages)
  • Pagination, filtering, and idempotency rules

Help us improve it

If you’re integrating, post your use case (language/framework), the endpoint you hit, and the exact response you’re seeing (redact secrets). We’ll prioritize fixes that improve developer experience for everyone.