Справочник API

Агенты

Создавайте простых ассистентов и чат-ботов для решения конкретных задач

Получить список всех агентов

HTTP

GET /chatflows Возвращает список всех доступных агентов

Авторизация

string required

bearerAuth JWT-токен

Коды ответов:

200 — успешная операция (возвращается массив объектов)
500 — внутренняя ошибка сервера

Пример ответа

[
  {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "name": "MyChatFlow",
    "flowData": "{}",
    "deployed": true,
    "isPublic": true,
    "apikeyid": "text",
    "chatbotConfig": "{}",
    "apiConfig": "{}",
    "analytic": "{}",
    "speechToText": "{}",
    "category": "category1;category2",
    "type": "CHATFLOW",
    "createdDate": "2024-08-24T14:15:22Z",
    "updatedDate": "2024-08-24T14:15:22Z"
  }
]

Получить агента по ID

HTTP

GET /chatflows/{id} Возвращает данные агента по его ID.

Авторизация

string required

bearerAuth JWT-токен

Параметры пути

string required

id (string) — ID агента

Коды ответов:

200 — успешно
400 — некорректный ID
404 — агент не найден
500 — внутренняя ошибка

Получить агента по API-ключу

HTTP

GET /chatflows/apikey/{apikey} Возвращает данные агента по его API-ключу.

Авторизация

string required

bearerAuth JWT-токен

Параметры пути

string required

apikey (string) — API-ключ

Коды ответов:

200 — успешно
400 — некорректный ID
404 — агент не найден
500 — внутренняя ошибка

Создать новый агент

HTTP

POST /chatflows Создаёт новый агент с указанными данными.

Авторизация

string required

bearerAuth JWT-токен

Тело запроса (application/json)

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "name": "MyChatFlow",
  "flowData": "{}",
  "deployed": true,
  "isPublic": true,
  "apikeyid": "text",
  "chatbotConfig": "{}",
  "apiConfig": "{}",
  "analytic": "{}",
  "speechToText": "{}",
  "category": "category1;category2",
  "type": "CHATFLOW",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}

Коды ответов:

200 — агент успешно создан
400 — некорректные входные данные
422 — ошибка валидации

Обновить данные агента

HTTP

PUT /chatflows/{id} Обновляет данные существующего агента.

Авторизация

string required

bearerAuth JWT-токен

Параметры пути

string required

id (string) — агента ID

Тело запроса: такое же, как при создании.

Коды ответов:

200 — агент успешно обновлён
400 — некорректный ID или отсутствует тело запроса
404 — агент не найден
500 — внутренняя ошибка

Удалить агент

HTTP

DELETE /chatflows/{id} Удаляет агента по его ID.

Авторизация

string required

bearerAuth JWT-токен

Параметры пути

string required

id (string) — агента ID

Коды ответов:

200 — агент успешно удалён (без содержимого)
400 — некорректный ID
404 — агент не найден
500 — внутренняя ошибка

Сообщение чата

База документов