Skip to main content

Versioning

The version lives in the path: every endpoint is under /1.0/.

https://api.zerowidth.ai/1.0/...

What changes within a version

/1.0 is a stability contract. While you're on it:

  • Additive changes ship in place — new endpoints, new optional request fields, new response fields. Write your client to ignore unknown response fields and these never break you.
  • Breaking changes get a new version. A removed field, a changed type, or different behavior lands under /1.1 or /2.0. /1.0 keeps serving its original contract, so you migrate on your own schedule.

Endpoints or fields still settling are marked Beta in their reference page; everything else is stable.

The MCP exception

The MCP server is mounted unversioned at /mcp, not under /1.0. That's deliberate: MCP negotiates its protocol version in-band during the connection handshake, so a version in the URL would be a redundant second channel. The path-version rule applies to the REST API; MCP carries its own.

Legacy surfaces

Older /v1 and /beta paths from the previous generation of the API are deprecated. They still respond, but every response carries Deprecation and Sunset headers pointing at the migration path, and they stop serving after their sunset date. New integrations should target /1.0.

2 min read