API

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

Создайте API-ключ

Откройте Settings → API Keys.
Нажмите Create API Key.
Введите Name и задайте Expiration Date.
Скопируйте ключ. Ключи выглядят так: sk-….

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

Базовый URL и аутентификация

Все эндпоинты находятся по пути /api/v1 на вашем домене Modelyx:

Пример запроса

https://app.modelyx.ai/api/v1

Передавайте ключ в заголовке Authorization каждого запроса:

Пример запроса

Authorization: Bearer sk-…

Запустите агента

Отправьте POST /api/v1/responses. В поле model укажите ID или slug агента, а в поле input — ваш запрос.

curl https://app.modelyx.ai/api/v1/responses \
  -H "Authorization: Bearer $MODELYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "YOUR_AGENT_ID_OR_SLUG",
    "input": "Summarize the top 10 customer complaints from this week in 5 bullet points."
  }'

В Modelyx поле model указывает на одного из ваших агентов, поэтому запрос выполняется с инструкциями, скиллами, коннекторами и знаниями этого агента. Чтобы узнать ID агента, откройте его: ID — это последняя часть адреса страницы (/agent/<id>).

Полный формат ответа описан в интерактивном справочнике по адресу /api/v1/docs.

Потоковый ответ

Добавьте "stream": true, чтобы получать ответ по мере генерации в виде server-sent events (SSE).

{
  "model": "YOUR_AGENT_ID_OR_SLUG",
  "input": "Draft a reply to this customer email: ...",
  "stream": true
}

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

Продолжите диалог

Чтобы отправить следующее сообщение в том же диалоге, передайте ID предыдущего ответа в previous_response_id. Тогда агент ответит с учётом предыдущих реплик.

{
  "model": "YOUR_AGENT_ID_OR_SLUG",
  "input": "Now make it shorter and more formal.",
  "previous_response_id": "PREVIOUS_RESPONSE_ID"
}

Вызов функций

Эндпоинт responses поддерживает вызов функций. Вы описываете в запросе функции своей системы, агент просит ваше приложение вызвать одну из них, когда она нужна, а приложение возвращает результат, чтобы агент продолжил работу. Так агент может найти заказ, проверить остатки или создать тикет в ваших системах. Точные поля запроса и ответа смотрите в /api/v1/docs.

Другие эндпоинты

Кроме запуска агентов, в API есть эндпоинты ресурсов:

Ресурс	Что охватывает
Agents	Ваши агенты.
Topics	Чаты с вашими агентами.
Messages	Сообщения внутри чата.
Files	Файлы, которые вы загружаете и используете.
Knowledge bases	Библиотеки, по которым ищут ваши агенты.
Models	Модели, доступные в вашем аккаунте.

Точные пути и параметры — в интерактивном справочнике.

Интерактивный справочник и спецификация

Интерактивный справочник: https://app.modelyx.ai/api/v1/docs. Просматривайте эндпоинты и пробуйте запросы.
Машиночитаемая спецификация: https://app.modelyx.ai/api/v1/openapi.json. По ней можно сгенерировать клиент на вашем языке.

Оплата

Запуски через API списывают кредиты так же, как чаты. См. Кредиты и расход.

API