Получить правила составления сценария

GET /api/v1/bots/{uniqueId}/scenarios/authoring-kit

URL

https://app.helpfy.ai/api/v1/bots/{uniqueId}/scenarios/authoring-kit

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

Заголовки

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

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

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

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

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

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

curl --request GET 'https://app.helpfy.ai/api/v1/bots/11111111-1111-4111-8111-111111111111/scenarios/authoring-kit' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json'

Ответы

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

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

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

{
  "manifest_version": 1,
  "format": "helpfy.bot-scenario",
  "schema_version": 2,
  "prompt_template": "example",
  "json_schema": {},
  "available_api_tools": [
    {
      "unique_id": "11111111-1111-4111-8111-111111111111",
      "name": "Служба поддержки",
      "description": "example",
      "request_method": "example",
      "input_schema_json": {}
    }
  ]
}

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

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

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