> ## Documentation Index
> Fetch the complete documentation index at: https://docs.apiyi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Magpie

> Подключите Magpie к APIYI через интерфейс приложения, настройте модели, URL API и ключи для Codex и Claude Code, а также устраните неполадки с помощью примеров CLI.

## Как Magpie подключается к APIYI

Magpie — это приложение с открытым исходным кодом для управления моделями и провайдерами инструментов для AI-разработки. После добавления APIYI в Magpie вы сможете выбирать модели для Codex, Claude Code и других инструментов в одном интерфейсе. Magpie записывает настройки в конфигурационные файлы каждого инструмента.

Запросы проходят через локальный шлюз, прежде чем попасть в APIYI:

```text theme={null}
Coding tool → Magpie gateway → APIYI → Model
```

Введите URL APIYI и свой настоящий ключ API в **настройках провайдера** Magpie. Magpie подключает ваши инструменты для разработки к локальному шлюзу, который по умолчанию прослушивает `127.0.0.1:3425`. Во время использования инструментов держите Magpie запущенным.

Проект: `github.com/yetone/magpie`; официальное руководство по началу работы: `usemagpie.ai/docs/start`.

## Перед началом

1. Скачайте настольное приложение для macOS, Windows или Linux с сайта `usemagpie.ai`, затем установите и откройте его.
2. Установите нужный инструмент для программирования. Инструкции по установке см. в разделах руководства по настройке [Codex](https://docs.apiyi.com/ru/scenarios/programming/codex-cli.md) или [Claude Code](https://docs.apiyi.com/ru/scenarios/programming/claude-code.md).
3. Подготовьте API-ключи на [странице токенов APIYI](https://api.apiyi.com/token). Убедитесь, что на вашем счёте есть доступный баланс и токены имеют доступ к выбранным моделям.

В этом руководстве описаны две записи провайдеров: **APIYI** и **APIYI Claude**. Если вы используете только один инструмент для программирования, настройте только соответствующую ему запись. Чтобы создать обе записи, используйте **два разных токена**: токен с доступом к моделям GPT для первой записи и токен из группы `ClaudeCode` для второй. Magpie считает конфигурации с одним и тем же ключом на одном и том же хосте дублирующимися провайдерами.

> [!NOTE]
>
> Magpie не считывает автоматически переменные среды с API-ключами из вашего терминала. Вставьте ключ в форму провайдера или добавьте его с помощью приведённых ниже команд CLI.

## Настройка через интерфейс рабочего стола

### Настройка провайдера для Codex

**1. Добавление пользовательского провайдера**

Откройте **Провайдеры → Добавить провайдера → Пользовательский провайдер** и укажите:

| Поле | Значение |
| - | - |
| Имя | `APIYI` |
| Основной протокол | **Совместимый с OpenAI** |
| Базовый URL | `https://api.apiyi.com/v1` |
| Ключ API | Ваш токен APIYI для моделей GPT |

Завершите URL на `/v1`. Magpie добавляет путь запроса, поэтому не указывайте полный путь `/chat/completions`.

**2. Добавление эндпоинта Responses для моделей GPT**

Раскройте раздел **Дополнительные эндпоинты** и задайте **URL Responses**: `https://api.apiyi.com/v1`.

В этом руководстве используется `gpt-5.4`, который поддерживает Chat Completions и Responses в APIYI. Codex может использовать эндпоинт Responses при доступе к этой модели через Magpie.

Настраивайте эндпоинт только в том случае, если APIYI поддерживает этот протокол для выбранной модели. Поддержка Responses в локальном шлюзе Magpie не означает, что каждая модель в APIYI поддерживает Responses нативно.

**3. Получение и выбор модели**

Нажмите **Получить модели**, выберите `gpt-5.4` в списке моделей и сохраните провайдера.

На начальном этапе выберите только эту модель. Прежде чем добавлять другие модели GPT, убедитесь, что они поддерживают те же эндпоинты в APIYI. Не добавляйте модели для генерации изображений, эмбеддингов и другие модели, не предназначенные для чата, в списки моделей ваших инструментов для работы с кодом.

Если нужная модель отсутствует в списке, вручную добавьте её точный идентификатор в разделе **Модели**. Введите `gpt-5.4` в поле модели провайдера без префикса `apiyi/`.

### Настройка провайдера для Claude Code

Добавьте ещё один **пользовательский провайдер**, используя другой токен из группы `ClaudeCode`:

| Поле | Значение |
| - | - |
| Имя | `APIYI Claude` |
| Основной протокол | **Совместимый с Anthropic** |
| Базовый URL | `https://api.apiyi.com` |
| Ключ API | Другой токен APIYI из группы `ClaudeCode` |
| Модели | `claude-sonnet-4-6` |

Указанный здесь URL **не включает `/v1`**. Magpie добавляет `/v1/messages`. После получения моделей выберите только ту модель Claude, которую планируете использовать. Также можно вручную ввести `claude-sonnet-4-6` и затем сохранить настройки.

> [!TIP]
>
> Отдельные записи провайдеров позволяют независимо управлять моделями, протоколами и группами токенов. Подробнее о группе `ClaudeCode` см. в разделе [Группы токенов](https://docs.apiyi.com/ru/faq/groups-explained.md).

### Выбор модели для каждого инструмента работы с кодом

1. Откройте раздел **Агенты** и найдите установленный инструмент **Codex** или **Claude Code**.
2. Нажмите на текущую модель инструмента, затем найдите и выберите модель у добавленного провайдера: **APIYI → gpt-5.4** для Codex или **APIYI Claude → claude-sonnet-4-6** для Claude Code.
3. Закройте старый сеанс инструмента, перезапустите его и откройте новый сеанс, чтобы он прочитал конфигурацию, записанную Magpie.

Внутри Magpie модели имеют идентификаторы вида `provider-id/model-id`, например `apiyi/gpt-5.4`. Необработанный идентификатор модели, введённый в форме провайдера, и полный идентификатор, выбранный для агента, выполняют разные функции.

> [!NOTE]
>
> Magpie записывает настройки API для управляемых им инструментов. При устранении неполадок также проверьте существующие переменные окружения, настройки проекта и другие менеджеры конфигурации, чтобы убедиться, что они не восстанавливают предыдущий URL сервиса.

## Проверка подключения

Сначала выполните тест на странице провайдера, а затем отправьте короткий запрос из инструмента для написания кода, например:

```text theme={null}
Reply with only: Connection successful.
```

Получив ответ, проверьте записи запросов или использования в Magpie, а также журналы вызовов в [консоли APIYI](https://api.apiyi.com). Убедитесь, что запрос был отправлен с нужной моделью и через нужного провайдера. Затем попросите инструмент объяснить небольшой файл в вашем проекте, чтобы проверить привычный рабочий процесс разработки.

**Успешное получение списка моделей подтверждает только доступность эндпоинта списка моделей.** Для запросов к чату также нужны подходящая модель, разрешения токена и протокол запросов. Тесты провайдера отправляют небольшое количество реальных API-запросов, которые тарифицируются в соответствии с использованием модели.

## Настройка через CLI

Если вы предпочитаете терминал, выполните следующие команды вместо добавления провайдеров через интерфейс. Сначала убедитесь, что команда `magpie` установлена, а настольное приложение запущено.

> [!NOTE]
>
> Если вы уже создали провайдеры через интерфейс, не запускайте `provider add` повторно. Выполните `magpie providers`, чтобы проверить фактические ID провайдеров, а затем подставьте эти ID в команды проверки или выбора модели. ID провайдеров, созданных через интерфейс, формируются на основе их названий; `id=` в команде позволяет указать конкретный ID. Если ID уже занят, Magpie может добавить суффикс, поэтому после добавления провайдеров через CLI тоже проверьте фактические ID.

### Добавление двух провайдеров

Замените `sk-your-api-key` в первой команде на ваш token для моделей GPT:

```bash theme={null}
magpie provider add APIYI id=apiyi url=https://api.apiyi.com/v1 responses=https://api.apiyi.com/v1 key=sk-your-api-key models=gpt-5.4
```

Замените `sk-your-api-key` во второй команде на другой token из группы `ClaudeCode`:

```bash theme={null}
magpie provider add "APIYI Claude" id=apiyi-claude anthropic=https://api.apiyi.com key=sk-your-api-key models=claude-sonnet-4-6
```

### Просмотр моделей и подключение инструментов

```bash theme={null}
magpie providers
magpie models
magpie codex model apiyi/gpt-5.4
magpie claude model apiyi-claude/claude-sonnet-4-6
```

Выполните только команду для установленного инструмента, который хотите настроить, а затем начните в нём новый сеанс. Эти команды обновляют конфигурацию; при использовании инструментов шлюз Magpie должен оставаться запущенным.

### Проверка вышестоящих провайдеров и локального шлюза

```bash theme={null}
magpie provider test apiyi
magpie provider test apiyi-claude
magpie healthcheck
```

`provider test` отправляет небольшое число реальных запросов к настроенным вышестоящим эндпоинтам. `healthcheck` проверяет только локальный шлюз, поэтому сам по себе не может подтвердить, что запросы к моделям через APIYI работают.

## Устранение неполадок

> **Аутентификация завершается ошибкой 401 или 403**
>
> Проверьте, что ключ API, сохранённый у провайдера Magpie, указан полностью и действителен, на вашем аккаунте APIYI доступен баланс, а токен имеет доступ к целевой модели. Для конфигурации Claude Code используйте токен из группы `ClaudeCode`. Изменение переменных окружения терминала автоматически не обновляет ключ, уже сохранённый в Magpie; вместо этого отредактируйте и сохраните провайдера.

> **Запросы возвращают ошибку 404 или ошибку «эндпоинт не найден»**
>
> Проверьте URL для выбранного протокола: используйте `https://api.apiyi.com/v1` для совместимых с OpenAI запросов и Responses, а `https://api.apiyi.com` для совместимых с Anthropic запросов. Не добавляйте полный путь запроса. Убедитесь, что целевая модель поддерживает этот эндпоинт, и не настраивайте эндпоинт Responses для модели, которая поддерживает только Chat Completions.

> **Список моделей загружается, но модель отсутствует в разделе «Агенты»**
>
> Убедитесь, что модель выбрана и сохранена у провайдера, затем проверьте собственный список видимых моделей агента. Выполните `magpie models`, чтобы увидеть модели, доступные в Magpie. При добавлении модели вручную проверьте её исходный идентификатор модели; при выборе модели для инструмента проверьте префикс провайдера и идентификатор.

> **При добавлении второго провайдера появляется предупреждение о дубликате**
>
> Magpie использует такие данные, как хост и ключ, для обнаружения дубликатов провайдеров. Для двух записей в этом руководстве требуются два разных токена APIYI. Изменение только имени провайдера или протокола всё равно может привести к предупреждению о дубликате.

> **Инструмент отсутствует в разделе «Агенты» или новая модель продолжает использовать старую конфигурацию**
>
> Убедитесь, что инструмент установлен, затем перезапустите Magpie и проверьте, обнаружен ли он. После выбора модели начните новый сеанс в инструменте. Проверьте, не переопределяют ли конфигурацию существующие переменные окружения, настройки проекта или другие менеджеры конфигурации. Инструкции по установке инструмента см. в соответствующем руководстве на этом сайте.

> **Инструменты для программирования не могут подключиться после закрытия Magpie**
>
> Теперь инструменты для программирования подключаются к локальному шлюзу. Закрытие Magpie прекращает пересылку запросов, если не запущен другой процесс шлюза. Снова откройте Magpie, затем выполните `magpie healthcheck`, чтобы проверить, работает ли локальный шлюз.

## Выбор модели и связанные ресурсы

Идентификаторы моделей в этом руководстве демонстрируют процесс настройки. Прежде чем добавлять другие модели, проверьте поддержку эндпоинта и разрешения token. Актуальные рекомендации по моделям и цены приведены на следующих страницах.

> **[Рекомендации по моделям](https://docs.apiyi.com/ru/api-capabilities/model-info.md)**
>
> Выбирайте модели для задач программирования и ознакомьтесь с рекомендациями по использованию.

> **[Цены на модели](https://docs.apiyi.com/ru/models/index.md)**
>
> Ознакомьтесь с актуальными ценами на модели APIYI и доступными моделями.

> **[Руководство по настройке Codex](https://docs.apiyi.com/ru/scenarios/programming/codex-cli.md)**
>
> Инструкции по установке инструментов, настройке моделей и использованию.

> **[Руководство по настройке Claude Code](https://docs.apiyi.com/ru/scenarios/programming/claude-code.md)**
>
> Информация об установке, группах token и устранении неполадок.

Официальная справка по настройке: `github.com/yetone/magpie/blob/main/docs/reference.md`. Шаги настройки в этом руководстве сверены с документацией и исходным кодом проекта. Проверьте получение списка моделей, потоковую передачу и вызов инструментов, отправив реальные запросы с выбранной моделью и протоколом.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.