Создать черновик сценария по описанию

POST /api/v1/bots/{uniqueId}/scenarios/generate

URL

https://app.helpfy.ai/api/v1/bots/{uniqueId}/scenarios/generate

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

Заголовки

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

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

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

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

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

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

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

Поле	Тип	Обязательно	Описание
prompt	строка	Да	Сообщение пользователя. (максимум символов: 12000)

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

curl --request POST 'https://app.helpfy.ai/api/v1/bots/11111111-1111-4111-8111-111111111111/scenarios/generate' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "prompt": "Создай сценарий проверки статуса заказа. Сначала спроси номер заказа, затем вызови функцию получения заказа и сообщи статус."
}
JSON

Ответы

HTTP	Описание
201	Успешный ответ
400	Неверные настройки сценария.
401	Требуется авторизация.
403	Нет доступа к боту.
404	Бот или сценарий не найден.

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

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

{
  "document": {
    "format": "helpfy.bot-scenario",
    "schema_version": 2,
    "exported_at": "example",
    "scenario": {
      "title": "example",
      "trigger_description": "example",
      "examples": [
        "example"
      ],
      "exclusions": [
        "example"
      ],
      "min_confidence": 50,
      "priority": 1,
      "allow_repeat_in_dialogue": false,
      "definition": {
        "start_node_id": "answer",
        "nodes": [
          {
            "id": "answer",
            "type": "FIXED_REPLY",
            "title": "Ответить клиенту",
            "text": "Адрес доставки можно изменить до передачи заказа в доставку."
          },
          {
            "id": "end",
            "type": "END",
            "title": "Завершить сценарий"
          }
        ],
        "edges": [
          {
            "id": "answer-end",
            "source": "answer",
            "target": "end",
            "priority": 100,
            "condition": {
              "type": "ALWAYS"
            }
          }
        ]
      }
    },
    "dependencies": {
      "api_tools": [
        {
          "name": "Служба поддержки",
          "request_method": "example"
        }
      ]
    }
  },
  "api_tool_dependencies": [
    {
      "name": "Служба поддержки",
      "request_method": "example",
      "status": "MATCHED"
    }
  ],
  "warnings": [
    "example"
  ],
  "charged_credits": 1
}

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

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

{
  "statusCode": 400,
  "error": "Bad Request",
  "code": "BAD_REQUEST",
  "message": "Bad Request"
}