Skip to main content
API V5 is unstable. Its endpoints can change in breaking ways, or be removed, without a deprecation period. Use API V4 for integrations that need a stable contract.
API V5 is where new endpoints, and new versions of existing ones, take shape before they’re stable. All API calls are relative to the base URL https://api.kit.com/v5/.

What unstable means

  • A V5 endpoint can change in a breaking way, or be removed, without a deprecation period.
  • Every change to a documented V5 endpoint is in the changelog under the API V5 tag, so check it before you update a client. The changelog also has an RSS feed.
  • When a V5 endpoint is ready for stable use, we’ll announce it in the changelog.

How V5 relates to V4

V5 only has endpoints that are new or that change how a V4 endpoint works. Everything else stays on V4, so an integration that uses V5 will usually call V4 too, and mixing the two versions is expected. A V5 endpoint doesn’t change its V4 counterpart: V4 keeps its existing behavior.

What V5 shares with V4

Telling V5 responses apart

V5 responses carry an X-Kit-API-Stability: unstable header, including authentication, validation and rate-limit errors. A client or an AI agent that never reads these docs can still tell it’s talking to an unstable version. V4 responses don’t carry the header.

Feedback

We’d like to hear how V5 works for you, and what you’d change before an endpoint is stable. Join the Developer Community to tell us.