> For the complete documentation index, see [llms.txt](https://docs.cherryai.com.cn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cherryai.com.cn/docs/russian/advanced-basic/developer-tools/api-gateway.md).

# API-шлюз

API-шлюз предоставляет уже настроенные в Cherry Studio возможности моделей локальным программам через совместимый с OpenAI и Anthropic HTTP API. Это также внутренний сервис, необходимый для работы Agent.

Путь: 【Настройки】→【API-шлюз】.

<figure><img src="/files/49333c8ba36b5818d7b459a837d74c0134afc51c" alt="API 网关设置中的运行状态、连接地址、端口和访问凭据"><figcaption><p>Перед подключением внешних программ сначала проверьте статус и порт; ключ предоставляйте только доверенным локальным программам или в контролируемой сети.</p></figcaption></figure>

## Использование Agent и внешних вызовов нужно различать

* Если используете только Cherry Studio Agent: достаточно нажать 【Включить и запустить】 по подсказке приложения, не нужно копировать URL или ключ в другие программы;
* Если локальной программе нужно вызывать Cherry Studio: запустите шлюз, скопируйте URL и API-ключ и выберите совместимый интерфейс согласно документации API;
* Если нужно предоставить доступ другим устройствам: это расширит область экспозиции, поэтому нужно самостоятельно проверить сетевое прослушивание, брандмауэр и контроль доступа; не рекомендуется открывать доступ без мер безопасности.

## Запуск и подключение

{% stepper %}
{% step %}

### 1. Проверьте порт

Порт можно изменить, когда шлюз остановлен. Выберите порт, не занятый другими программами; при конфликте портов служба не сможет нормально запуститься.
{% endstep %}

{% step %}

### 2. Запустите шлюз

Нажмите 【Запустить】; после того как статус станет 【В работе】, на странице отобразится доступный URL и будет доступен вход в 【Документацию API】.
{% endstep %}

{% step %}

### 3. Настройте авторизацию

Использование внешними программами `Authorization: Bearer <API-ключ>`На странице можно напрямую скопировать заголовок авторизации; не записывайте ключ в репозиторий кода или на скриншоты.
{% endstep %}

{% step %}

### 4. Проверьте минимальным запросом

Сначала, согласно документации API, запросите список моделей или отправьте короткий текст, а затем подключайте полноценное приложение. При ошибке записывайте HTTP-статус и ответ, не раскрывая полный заголовок авторизации.
{% endstep %}
{% endstepper %}

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

Сначала в 【Настройки】→【Сервис моделей】 убедитесь, что модель нормально отвечает, затем запустите API-шлюз. Скрипт сохраняет только адрес локального шлюза и ключ, сначала запрашивает список моделей, затем отправляет короткий текст. Перед подключением полноценной программы убедитесь, что клиент поддерживает совместимый с OpenAI или Anthropic интерфейс.

| Настройка             | Рекомендуемая отправная точка                     | Роль                                       | Примечания                                                                  |
| --------------------- | ------------------------------------------------- | ------------------------------------------ | --------------------------------------------------------------------------- |
| Область прослушивания | Только для локального использования               | Сократить сетевую экспозицию               | Не открывать напрямую в локальную сеть или в интернет ради удобства отладки |
| API-ключ              | Хранить отдельно для текущего шлюза               | Проверить запросы клиента                  | Не записывать в репозиторий, скриншоты или общие журналы                    |
| Проверка запросов     | Сначала проверьте список моделей и короткий текст | Проверяйте соединение и генерацию отдельно | При сбое записывайте код состояния, не записывайте полный ключ              |

### Критерии завершения

Шлюз отображается как 【В работе】; список моделей читается; запрос короткого текста успешен; после остановки шлюза клиент больше не может вызывать сервис.

## Безопасные действия

{% hint style="danger" %}
API-ключ может вызывать сервисы моделей, настроенные вами в Cherry Studio. Если ключ утёк, сначала остановите шлюз, затем в состоянии остановки нажмите 【Сгенерировать заново】 и после этого обновите всех локальных клиентов.
{% endhint %}

* Когда шлюз запущен, порт и ключ остаются только для чтения; перед изменением сначала остановите его;
* Не показывайте ключ в публичных репозиториях, issue, журналах или на скриншотах в инструкциях;
* Сохраняйте ключ только для программ, которым он нужен для вызова;
* Потребление и расходы по-прежнему формируются реальным поставщиком модели; записи Cherry Studio можно посмотреть в 【Настройки】→【Статистика использования】.

<details>

<summary>Какова связь между API-шлюзом и сервисом моделей?</summary>

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

</details>

<details>

<summary>Что делать, если порт в порядке, но клиент возвращает неавторизован?</summary>

Убедитесь, что заголовок запроса — `Authorization: Bearer ...`без лишних кавычек или пробелов, и проверьте, что ключ, используемый клиентом, всё ещё соответствует текущему значению на странице.

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.cherryai.com.cn/docs/russian/advanced-basic/developer-tools/api-gateway.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.