Справочник API

Каждая страница этого раздела сгенерирована из apps/api/openapi.json (pnpm --filter @typizer/docs openapi:generate) — вручную эти страницы не редактируются: при изменении API они перегенерируются заново, и разъехавшийся с кодом справочник ловит CI. Разделы слева — это теги OpenAPI: «Аккаунт», «Организация», «Ключи API», «Файлы», «Типизаторы», «Прогоны», «Пакеты», «Вебхуки», «Биллинг», «Статус», «Метаданные».

В справочник не попадают операции, нужные только из сессии Кабинета, а не для интеграции по ключу API: вход, помощник-ассистент построения схем (Agent), необязательные согласия и демо-страница лендинга, а также удаление своего аккаунта и список своих входов. Полная спецификация, включая их, всегда доступна по GET /v1/openapi.json.

Что дальшеСкопировать ссылку

• «Первый вызов API» — пошагово, с curl, TypeScript и Python.
• «SDK» — те же операции через готовый клиент для TypeScript и Python.
• «Коды ошибок» — коды code/type, которые может вернуть любая из операций.