Skip to the content

DocsReference

Changelog

What changed in the API, and the compatibility promise.

/v1 changes are additive only: new fields, parameters and values may appear, so ignore what you don't know. A breaking change means /v2, with /v1 kept for at least six months.

v1

  • GET /v1/resolve, /v1/models, /v1/models/{vendor}/{model}, /v1/purposes, /v1/vocabulary and /v1/licenses.
  • Self-service accounts, API keys, test keys and usage.
  • Teams and escalation: shape=team and shape=escalation with strategy, roles, length, synthesis, origin_mix and providers_distinct; the team and escalation answer fields; shape: "auto" in /v1/plan.
  • Local models: /v1/vocabulary lists the local runtimes (ollama, lmstudio, llama.cpp, mlx, webllm) with local: true, and /v1/models lists their free offerings. If you build providers from the vocabulary, leave out local: true entries or send max_memory_gb or max_vram_gb: local runtimes listed with cloud providers and neither limit answer 400 invalid_request. New: max_memory_gb, max_vram_gb, max_disk_gb, the answer's requirements and the no_device_limits warning.
  • Answer change emails: an opt-in daily digest when your answers change (below). No /v1 change.

Answer change emails

Your answers change only when the catalog does. To hear about it without polling, an admin or the owner turns on Notify me when my answers change in Settings (off by default). While it is on, each successful /v1/resolve and /v1/plan call made with a live key keeps the need it resolved and the answer: the task or purpose, providers, constraints and shape, the key's project, and the chosen model, provider and provider model id of each member. For /v1/plan it is only what the request stated, with the defaults: never the prompt, tags or attachments, nor a value read from the prompt or attachments, such as its size. A need naming an unknown id or role is not kept. Test keys and the sandbox are never recorded.

After each daily catalog refresh, every kept need is resolved again. When an answer changed, no longer resolves, or resolves to a model that retires within 30 days, the owner and admins (verified emails) get one email that day, for example: "The answer for face-bananas' photo-edit-with-reference / gemini changed from … to …", or "… retires on 2026-12-15". Up to 100 needs are kept, the least recently used dropped first; a need unused for 30 days is deleted. Turning the setting off deletes them all at once, and the change shows in the audit log.