API-сервер

Основная роль API-сервера:Открывать наружу через локальный интерфейс уже настроенные в Cherry Studio возможности ИИ(а также базовую зависимость функций агентов), чтобы другие программы могли их вызывать.

Сценарий использования: вы уже настроили в Cherry Studio провайдеров OpenAI, Anthropic, DeepSeek и т. д. Если ваши другие инструменты (например, какой-то плагин для программирования или пользовательский скрипт) хотят вызывать те же возможности ИИ,API-сервербудет открыт на локальной машине стандартный интерфейс, чтобы эти инструменты могли напрямую использовать уже настроенные в Cherry Studio возможности без повторной регистрации у каждого провайдера.

Когда нужно включать?

• Использовать агента → Обязательно включить
• Подключить Agent к IM-платформам (канал) → Обязательно включить
• Только для обычного чата, рисования, перевода и других функций Cherry Studio → Включать не нужно

Рекомендуем сначала прочитать Введение в концепции Ознакомьтесь с понятиями Agent, каналов и связанными терминами.

Включить API-сервер

1. Открыть Настройки → API-сервер
2. Порт прослушивания по умолчанию — 23333, можно указать 1000-65535 любой свободный порт между
3. Нажмите на зелёную кнопку в правом верхнем углу ▶ Запустить кнопка

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

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

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

Способ изменения порта: поле ввода порта только для чтения, пока сервер работает. Если нужно изменить, сначала нажмите ⏹ Остановить, затем измените порт и снова запустите.

API-ключ и заголовок авторизации

Ключ APIв виде cs-sk-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, автоматически генерируется при первом включении API-сервера исохраняется постоянно, при перезапуске сервера не обновляется.

Если нужно вручную заменить:сначала нажмите ⏹, чтобы остановить сервер, и только тогда справа от ключа появится кнопка Сгенерировать заново (во время работы отображается только кнопка копирования). После нажатия старый ключ сразу станет недействительным, при следующем запуске будет создан новый ключ.

При вызове API нужно добавить в заголовок запроса:

Authorization: Bearer cs-sk-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

API-ключ имеет доступ ко всем провайдерам в вашем Cherry Studio,не раскрывайте его в публичном доступе или в общих каналах команды。

Посмотреть документацию API

Нажмите в правом верхнем углу страницы Документация API кнопку, чтобы открыть встроенную документацию интерфейса OpenAPI (в стиле Swagger), включая полный список эндпоинтов и примеры запросов.

Поиск и устранение конфликта портов

Запуск не удался и появилось сообщение EADDRINUSE: address already in use 127.0.0.1:<port> когда:

1. скорее всего, этот же порт уже занят другим экземпляром Cherry Studio
2. Нажмите ⏹, остановите, измените порт на другой свободный и снова запустите
3. или выполните в терминале lsof -i :<port>(macOS / Linux), чтобы найти процесс, который занимает порт, и устранить проблему

Перезапуск и остановка

• Перезапуск: нажмите значок ↻, обычно используется для принудительного обновления всех соединений после повторной генерации ключа
• Остановить: нажмите красный значок ⏹, сервис немедленно закроется; соединения, использующие агента и канал его, тоже будут прерваны

API-сервер слушает только 127.0.0.1,не будетне открывая доступ в локальную сеть или в интернет. Если нужен доступ с других машин, используйте SSH reverse tunnel или аналогичное решение.

Далее

• После включения можно продолжить настройку агента
• Если хотите подключить Agent к IM-платформам, таким как Feishu / Telegram / Discord, прочитайте канал

---

💡 Получить помощь и отправить отзыв

Если вы в процессе настройки или использования столкнётесь с любыми вопросами, багами или предложениями по улучшению функций, пожалуйста, обратитесь к Обратная связь и предложения официальным каналам, указанным там.