Агент и его настройки

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

Карточка агента

GET /v1/agent

Возвращает карточку агента, для которого создан ключ. Работает для агента любого типа.

Ответ

200 — объект Agent:

Поле	Тип	Описание
`id`	string	Идентификатор агента
`name`	string	Название
`description`	string	Описание
`type`	string	Тип: `assistant` — Ассистент, `agent` — Агент, `chatflow` — Chatflow, `autonomous` — автономный агент, `completion`, `workflow`. Методы диалога доступны только для `assistant` и `agent`
`tags`	string[]	Названия тегов агента

Пример

curl https://api.evo-ai.ru/v1/agent \
  -H "Authorization: Bearer evo_agent_..."

{
  "id": "5b0f6c1e-2a47-4d8e-9c31-7e2f8a4b6d10",
  "name": "Юрист",
  "description": "Помогает с договорами и претензиями",
  "type": "agent",
  "tags": ["право"]
}

Настройки агента

GET /v1/agent/settings

Возвращает настройки агента в том виде, в каком они действуют сейчас.

Ответ

200 — объект AgentSettings:

Поле	Тип	Описание
`greeting`	object	Приветствие: `text` — текст приветствия, `questions` — стартовые вопросы. Если Приветствие выключено, `text` — `null`, `questions` — пустой список
`follow_up_questions`	boolean	Включены ли Подсказки вопросов
`show_sources`	boolean	Включено ли Отображение источников. Действует и в уже начатых диалогах: следующий ответ идёт по текущим опубликованным настройкам агента
`file_upload`	object	Загрузка файлов в сообщения — см. ниже
`variables`	array	Переменные старта — объекты Variable, см. ниже. У агента без переменных — пустой список

file_upload:

Поле	Тип	Описание
`enabled`	boolean	Включена ли загрузка файлов. Если выключена, `types` — пустой список
`types`	string[]	Какие типы файлов можно отправлять агенту: `document`, `image`, `audio`, `video`, `other`
`max_files`	integer	Сколько файлов можно приложить к одному сообщению
`max_size_mb`	object	Предельный размер файла в МБ по типам: `document`, `image`, `audio`, `video`, `other`. Если у агента предел для типа не задан, приходит предел платформы. У `other` — тот же предел, что у `document`

Variable — переменная старта:

Поле	Тип	Описание
`name`	string	Ключ значения в поле `variables` первого сообщения
`label`	string	Подпись поля
`type`	string	Тип: `text`, `paragraph`, `select`, `number`, `checkbox`, `file`, `files`, `json`
`required`	boolean	Обязательна ли переменная
`options`	string[]	Допустимые значения — только у `select`, у остальных типов `null`
`max_length`	integer	Предельная длина текста — у `text` и `paragraph`, у остальных типов `null`
`max_files`	integer	Сколько файлов можно передать — у `files`, у остальных типов `null`
`max_size_mb`	number	Собственный предел размера файла переменной в МБ — у `file` и `files`; `null`, если своего предела у переменной нет, и у остальных типов

Все поля Variable приходят всегда: поле, которое не относится к типу переменной, — null. Если у файловой переменной пределы заданы по-разному для разных типов файлов, в max_size_mb приходит наибольший; без собственного предела действует предел агента для типа файла. Скрытые переменные, которые пользователь чата не видит, в списке тоже есть: их значения передаёт ваше приложение.

Пример

curl https://api.evo-ai.ru/v1/agent/settings \
  -H "Authorization: Bearer evo_agent_..."

{
  "greeting": {
    "text": "Здравствуйте! Чем могу помочь?",
    "questions": ["Проверь договор", "Составь претензию"]
  },
  "follow_up_questions": true,
  "show_sources": false,
  "file_upload": {
    "enabled": true,
    "types": ["document", "image"],
    "max_files": 5,
    "max_size_mb": {
      "document": 50,
      "image": 10,
      "audio": 150,
      "video": 200,
      "other": 50
    }
  },
  "variables": [
    {
      "name": "company",
      "label": "Компания",
      "type": "text",
      "required": true,
      "options": null,
      "max_length": 48,
      "max_files": null,
      "max_size_mb": null
    },
    {
      "name": "tone",
      "label": "Тон ответа",
      "type": "select",
      "required": false,
      "options": ["строгий", "мягкий"],
      "max_length": null,
      "max_files": null,
      "max_size_mb": null
    }
  ]
}

Ошибки

HTTP	Код	Когда
`400`	`unsupported_agent_type`	Тип агента — не Ассистент и не Агент
`400`	`agent_unavailable`	Агент не настроен или недоступен на платформе

Общие ошибки — неверный ключ, выключенный доступ по API — на странице Ошибки.

Агенты

Отправка сообщений