Changelog

Versioning#

The version is in the path: /api/v1/….

Within a version, changes are additive only. New fields may appear on responses and new optional fields may be accepted on requests. Nothing is removed and nothing changes meaning.

So write clients that ignore fields they do not recognise. A response growing a field should never be a deployment.

Anything that would break existing code — a removed field, a renamed one, a changed default — goes in /api/v2, and v1 keeps working while you move.

Availability#

v1 is live and accepting requests.

Everything documented here is under the additive-only promise above: write against it and it keeps working. Endpoint and field names are fixed — a change that would break existing code goes in v2, not into this version.

This page used to carry a preview notice saying the opposite, published while the surface was still being argued with. It no longer applies.

Planned#

Designed, not yet released. Listed so you can tell what is coming from what is missing.

Catalogue search without the assistant. Query your records directly, with the same SQL-compiling filter engine, no model in the path. For building a filterable listing page rather than a conversation.

Knowledge search without the assistant. Semantic passage retrieval with similarity scores, for your own search box or your own retrieval pipeline.

Outbound webhooks. We call your endpoint when a session ends or a handoff is requested, instead of you polling for it.

Sandbox keys. A zv_test_ prefix that reaches real assistants without metering, so a test suite does not appear in your usage.

Idempotency keys. Safe retries on POST.

Browser client tokens. A short-lived, origin-locked token your server mints so a page can call speech endpoints directly, removing the proxy hop from the latency-critical voice path. Additive — the server-side pattern keeps working unchanged.

Release notes#

Every change to v1 will be listed here, newest first, with a date and a note on whether anything needs doing.

Nothing to report yet — the first entry lands with the first release.