Получить ответ синхронно

POST /api/v1/bots/{uniqueId}/completion/sync

Отправляет сообщение боту и возвращает результат в том же HTTP-запросе.

URL

https://app.helpfy.ai/api/v1/bots/{uniqueId}/completion/sync

Адрес своей установки подставьте вместо https://app.helpfy.ai. Идентификаторы в фигурных скобках замените значениями из ответов API.

Заголовки

Заголовок	Значение
Authorization	Basic <base64(email:api_key)>
Accept	application/json

Для JSON-тела передайте Content-Type: application/json.

Подробнее — авторизация API.

Параметры запроса

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

Параметр	Тип	Обязательный	Описание
uniqueId	строка	Да	Идентификатор бота.

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

Поле	Тип	Обязательно	Описание
prompt	строка	Да	Сообщение пользователя, на которое должен ответить бот.
system_direct	строка	Нет	Дополнительная системная инструкция для режима DIRECT.
dialogue_id	строка	Нет	Идентификатор диалога.
dialogue	объект	Нет	Настройки диалога.
meta	объект	Нет	Ваши дополнительные данные, которые вернутся с результатом. JSON-объект размером до 5 КБ после преобразования в строку.
mode	PROMPTER, SUPPORT, DIRECT	Нет	Режим ответа. По умолчанию PROMPTER — подготовка ответа сотруднику.
is_depersonalize	логическое значение	Нет	Обезличивать данные в этом запросе режима DIRECT. По умолчанию false; в других режимах поле не применяется. (по умолчанию: false)
attachment_ids	массив: строка	Нет	Идентификаторы вложений, загруженных отдельным запросом.

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

curl --request POST 'https://app.helpfy.ai/api/v1/bots/11111111-1111-4111-8111-111111111111/completion/sync' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "prompt": "Как изменить адрес доставки?"
}
JSON

Ответы

HTTP	Описание
200	Успешный ответ
400	Неверные параметры запроса.
402	Недостаточно кредитов на счёте.
404	Бот или диалог не найден.

Пример ответа — HTTP 200

Сокращённый пример; показаны клиентские поля. Значения условные.

{
  "response": {
    "statusCode": 400,
    "message": "example"
  },
  "meta": {
    "prompt": "Как изменить адрес доставки?"
  },
  "error": false,
  "type": "SUCCESS"
}

Пример ошибки — HTTP 400 (1)

Пример структуры ошибки. Код и сообщение зависят от причины ошибки.

{
  "statusCode": 400,
  "message": "No integration profile found for bot with unique id: unique_id, set integration data first",
  "error": "Bad Request"
}

Пример ошибки — HTTP 400 (2)

Пример структуры ошибки. Код и сообщение зависят от причины ошибки.

{
  "statusCode": 400,
  "message": "Integration with GigaChat not approved, please check bot integrations settings page",
  "error": "Bad Request"
}

Пример ошибки — HTTP 402

Пример структуры ошибки. Код и сообщение зависят от причины ошибки.

{
  "statusCode": 402,
  "message": "Insufficient credits on balance",
  "error": "Payment Required"
}

Пример ошибки — HTTP 404 (1)

Пример структуры ошибки. Код и сообщение зависят от причины ошибки.

{
  "statusCode": 404,
  "message": "Bot with unique id: unique_id not found",
  "error": "Not Found"
}

Пример ошибки — HTTP 404 (2)

Пример структуры ошибки. Код и сообщение зависят от причины ошибки.

{
  "statusCode": 404,
  "message": "Dialogue with unique id: unique_id not found",
  "error": "Not Found"
}