Skip to Content
Справочник APIИстория изменений

История изменений

Эта страница отслеживает изменения контракта API для разработчиков, чтобы вы могли отслеживать поверхность, от которой зависит ваша интеграция.

v1 — Стабильная (2026-06)

Первый публичный выпуск API для разработчиков Cuneiform Chat. v1 — это текущий, стабильный контракт, и он устанавливает базовую точку для всего, что описано в этом справочнике:

  • Аутентификация — защищённый учётными данными доступ с key cuk_<env>_<random>, предъявляемым как Authorization: Bearer cuk_… или X-API-Key: cuk_…. Пять scopes: knowledge:read, knowledge:write, agents:read, agents:write, agents:query.
  • Knowledge — асинхронная загрузка документов, перечисление, поиск, получение, статус (опрос + SSE) и удаление; CRUD папок и tags; организация документов (перемещение в папку, добавление/удаление tags).
  • Agents — создание, перечисление, получение, обновление, архивирование (soft-delete) и восстановление; чтение и обновление конфигурации agent.
  • Запрос к Agent — запуск agent в режиме блокирующего JSON или в режиме потокового SSE.
  • Соглашения — курсорная пагинация с непрозрачным курсором, контракт Idempotency-Key, конверт ошибки в стиле Stripe и заголовки RateLimit-*.

Как развивается контракт

v1 аддитивен и стабилен:

  • В рамках v1 могут вводиться новые поля и новые endpoints.
  • Существующие поля никогда не удаляются и не переназначаются в рамках v1.
  • Категории ошибок никогда не переназначаются — может быть добавлена новая категория, но существующая сохраняет свой смысл, поэтому ветвление по type ошибки безопасно.

Несовместимое изменение будет выпущено под новым префиксом версии (/v2), а не молча в рамках v1.

Last updated on