Skip to main content
Аккаунт и ключ по-прежнему должны быть созданы вами в консоли. Всё — от «у меня есть ключ» до «код работает» — можно делегировать ИИ одним из трёх способов ниже.

​
Выберите путь

Навыки · чат-агенты

OpenClaw, Claude Code и другие агенты с системой навыков. Установите навык один раз, затем вызывайте APIYI на естественном языке.

CLI · терминал

Без кода. Проверьте ключ, просмотрите список моделей, отправьте сообщение и сгенерируйте изображение из терминала. npx apiyi@latest check не требует установки.

Комплект разработчика · агенты для программирования

Cursor, Claude Code и Codex читают контракт и реестр моделей перед написанием кода интеграции. Никаких выдуманных эндпоинтов.

​
Что входит в комплект

Все файлы общедоступны. Авторизация не требуется, и любой агент может напрямую получить к ним доступ:
Версия этой страницы в виде обычного текста доступна по адресу https://docs.apiyi.com/en/developer-kit.md.

​
Правила для агентов, работающих с кодом

Наиболее распространённая ошибка агента, работающего с кодом, — это не плохой код. Это написание по памяти: выдумывание несуществующего эндпоинта, ввод gpt-5-4-mini вместо gpt-5.4-mini или добавление лишнего /v1 к базовому URL Anthropic SDK. Этого не допустить помогут пять правил:
  1. Не выдумывайте эндпоинты, имена параметров, значения enum или структуры ответов. Используйте только пути из таблицы эндпоинтов skill.md; параметры должны соответствовать официальному определению используемого протокола (OpenAI, Anthropic или Gemini).
  2. model-registry.json — единственный источник истины для идентификаторов моделей. Идентификаторы используют точечные версии и чувствительны к регистру. Дефисы в URL документации — это безопасные для URL замены, а не идентификаторы моделей.
  3. Выбирайте базовый URL по SDK, а не по модели. OpenAI SDK использует https://api.apiyi.com/v1; Anthropic SDK использует корневой https://api.apiyi.com; Google GenAI SDK использует корневой URL с параметром api_version, установленным в v1beta.
  4. Читайте ключ только из переменной окружения APIYI_API_KEY. Никогда не встраивайте его в код, не добавляйте в репозиторий и не вставляйте в чат.
  5. Сначала объяснение, затем редактирование. Попросите агента указать, какой эндпоинт, какую модель и какой тайм-аут он планирует использовать. Он должен редактировать код только после вашего подтверждения.

Полный промпт для Cursor, Claude Code, Codex и других агентов, работающих с кодом. Скопируйте и вставьте без изменений.

​
Навыки

Навык — это сам skill.md: справочник по интеграции, написанный для машин. После установки агент обращается к этим правилам каждый раз, когда ему нужно вызвать APIYI. Три способа установки:
Для Claude Code, Cursor, Codex и любого другого инструмента, поддерживающего спецификацию Agent Skills:
Обнаружение выполняется через /.well-known/agent-skills/index.json этого сайта. При этом устанавливается сам skill.md без скриптов; для самопроверки используйте npx apiyi@latest check.

Для OpenClaw, Claude Code, Cursor и других агентов, поддерживающих навыки. Скопируйте и вставьте как есть.

​
Как ключ передается агенту

  • Переменная окружения APIYI_API_KEY имеет наивысший приоритет. Навык, CLI и все примеры в этой документации считывают ключ оттуда.
  • OpenClaw хранит ключ в skills.entries.apiyi.apiKey в ~/.openclaw/openclaw.json и передает его как APIYI_API_KEY во время выполнения. Именно это объявляет поле primaryEnv во frontmatter навыка. Структуру файлов см. в разделе Файл конфигурации OpenClaw.
  • CLI сохраняет его с помощью npx apiyi@latest auth set-key в ~/.config/apiyi/config.json с правами доступа 0600.

​
Статусы самопроверки

Скрипт навыка, CLI и ручной вызов curl возвращают один и тот же набор статусов:
Обычный ключ sk- не может проверять баланс, поэтому статус no_balance отсутствует. Для баланса и логов используются отдельные учетные данные — personal access token (начинается с nap_). См. Что такое Personal Access Token?. Ошибка 429 может означать как лимит запросов, так и нулевой баланс. Агент не должен гадать; ему следует направить вас в консоль.

​
CLI

Выполните первый запрос из терминала без написания кода. Node 18 или новее, ничего устанавливать не нужно:
npx запускает CLI без установки команды apiyi. Для краткости в таблице ниже команды записаны как apiyi …; при использовании npx укажите npx apiyi@latest … (например, npx apiyi@latest auth set-key). Чтобы вводить apiyi без дополнительных символов, установите его один раз с помощью npm i -g apiyi. См. статью Почему терминал сообщает, что команда apiyi не найдена?

Подойдёт любой агент, способный выполнять команды терминала. Также вы можете выполнить эти строки самостоятельно.

​
Команды

Глобальные флаги: --api-key, --access-token, --node api|vip|b|cf (выбор узла), --base-url, --timeout, --json (машиночитаемый вывод).

​
Порядок поиска ключа

Сначала проверяется флаг --api-key, затем переменная среды APIYI_API_KEY, далее ~/.config/apiyi/config.json и затем ~/.openclaw/openclaw.json в OpenClaw. Если вы уже установили навык OpenClaw, CLI повторно использует этот ключ.

​
Коды завершения

Скрипты и агенты используют код завершения для ветвления, а не разбирают текст: Исходный код находится в github.com/apiyi-com/cli; пакет npm — в apiyi. В документации всегда указывается npx apiyi@latest, поскольку npx кэширует старые версии.

​
Поля model-registry.json

Файл регенерируется при каждом обновлении таблицы цен из тех же данных, что и страница цен на модели. Поля верхнего уровня: Каждая запись о модели:
Цены в реестре являются публичными ценами. Они не включают бонусы за пополнение и скидки для групп; фактические списания соответствуют данным в консоли. Описание групп приведено на странице Описание групп.

​
Связанные страницы

Начало работы

Два пути: поручить интеграцию ИИ или выполнить её самостоятельно.

Возможна ли интеграция в один клик?

Да, в виде передачи документации ИИ, а не нажатия кнопки.

OpenClaw

Локальный ИИ-помощник с открытым исходным кодом; после установки навыка он обращается к APIYI на естественном языке.

Цены на модели

Версия реестра, удобная для чтения, с группировкой по поставщикам и ценами по уровням.