> 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/api-server.md). # API-сервер Основная роль API-сервера:**Открывать наружу через локальный интерфейс уже настроенные в Cherry Studio возможности ИИ**(а также базовую зависимость функций агентов), чтобы другие программы могли их вызывать. Сценарий использования: вы уже настроили в Cherry Studio провайдеров OpenAI, Anthropic, DeepSeek и т. д. Если ваши другие инструменты (например, какой-то плагин для программирования или пользовательский скрипт) хотят вызывать те же возможности ИИ,**API-сервер**будет открыт на локальной машине стандартный интерфейс, чтобы эти инструменты могли напрямую использовать уже настроенные в Cherry Studio возможности без повторной регистрации у каждого провайдера. **Когда нужно включать?** * Использовать [агента](/docs/russian/cherry-studio/preview/agent.md) → **Обязательно включить** * Подключить Agent к IM-платформам ([канал](/docs/russian/advanced-basic/agent-channels.md)) → **Обязательно включить** * Только для обычного чата, рисования, перевода и других функций Cherry Studio → **Включать не нужно** > Рекомендуем сначала прочитать [Введение в концепции](/docs/russian/advanced-basic/concepts-101.md) Ознакомьтесь с понятиями Agent, каналов и связанными терминами. ### Включить API-сервер 1. Открыть `Настройки → API-сервер` 2. Порт прослушивания по умолчанию — **23333**, можно указать **1000-65535** любой свободный порт между 3. Нажмите на зелёную кнопку в правом верхнем углу **▶ Запустить** кнопка

Когда не включено, отображается «Остановлено» и появляется подсказка «Пожалуйста, включите API-сервер, чтобы использовать функции агента»

После успешного запуска статус становится зелёным **работает**, и отображается адрес прослушивания `http://127.0.0.1:`：

Состояние работы, включает кнопки «Перезапустить» и «Остановить»

{% hint style="info" %} **Способ изменения порта**: поле ввода порта только для чтения, пока сервер работает. Если нужно изменить, сначала нажмите ⏹ **Остановить**, затем измените порт и снова запустите. {% endhint %} ### API-ключ и заголовок авторизации **Ключ API**в виде `cs-sk-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`, автоматически генерируется при первом включении API-сервера и**сохраняется постоянно**, при перезапуске сервера не обновляется. Если нужно вручную заменить:**сначала нажмите ⏹, чтобы остановить сервер**, и только тогда справа от ключа появится кнопка **Сгенерировать заново** (во время работы отображается только кнопка копирования). После нажатия старый ключ сразу станет недействительным, при следующем запуске будет создан новый ключ. При вызове API нужно добавить в заголовок запроса: ``` Authorization: Bearer cs-sk-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ``` {% hint style="warning" %} API-ключ имеет доступ ко всем провайдерам в вашем Cherry Studio,**не раскрывайте его в публичном доступе или в общих каналах команды**。 {% endhint %} ### Посмотреть документацию API Нажмите в правом верхнем углу страницы **Документация API** кнопку, чтобы открыть встроенную документацию интерфейса OpenAPI (в стиле Swagger), включая полный список эндпоинтов и примеры запросов. ### Поиск и устранение конфликта портов Запуск не удался и появилось сообщение `EADDRINUSE: address already in use 127.0.0.1:` когда: 1. скорее всего, этот же порт уже занят другим экземпляром Cherry Studio 2. Нажмите ⏹, остановите, измените порт на другой свободный и снова запустите 3. или выполните в терминале `lsof -i :`(macOS / Linux), чтобы найти процесс, который занимает порт, и устранить проблему ### Перезапуск и остановка * **Перезапуск**: нажмите значок ↻, обычно используется для принудительного обновления всех соединений после повторной генерации ключа * **Остановить**: нажмите красный значок ⏹, сервис немедленно закроется; соединения, использующие [агента](/docs/russian/cherry-studio/preview/agent.md) и [канал](/docs/russian/advanced-basic/agent-channels.md) его, тоже будут прерваны {% hint style="info" %} API-сервер слушает только `127.0.0.1`,**не будет**не открывая доступ в локальную сеть или в интернет. Если нужен доступ с других машин, используйте SSH reverse tunnel или аналогичное решение. {% endhint %} ### Далее * После включения можно продолжить настройку [агента](/docs/russian/cherry-studio/preview/agent.md) * Если хотите подключить Agent к IM-платформам, таким как Feishu / Telegram / Discord, прочитайте [канал](/docs/russian/advanced-basic/agent-channels.md) *** ### 💡 Получить помощь и отправить отзыв Если вы в процессе настройки или использования столкнётесь с любыми вопросами, багами или предложениями по улучшению функций, пожалуйста, обратитесь к [Обратная связь и предложения](/docs/russian/question-contact/suggestions.md) официальным каналам, указанным там. --- # 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/api-server.md?ask=&goal= ``` `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.