Получить функцию

GET /api/v1/bot-tools/{uniqueId}

URL

https://app.helpfy.ai/api/v1/bot-tools/{uniqueId}

Адрес своей установки подставьте вместо 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/bot-tools/11111111-1111-4111-8111-111111111111' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json'

Ответы

HTTP	Описание
200	Успешный ответ

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

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

{
  "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
  "name": "get_weather",
  "description": "Возвращает погоду в указанном городе.",
  "strict": true,
  "is_enabled": true,
  "request_method": "POST",
  "request_url": "https://api.example.com/weather?city={location}",
  "input_schema_json": {
    "type": "object",
    "properties": {
      "location": {
        "type": "string"
      }
    }
  },
  "timeout_ms": 5000,
  "max_response_bytes": 65536,
  "allow_redirects": false,
  "headers": [
    {
      "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
      "header_name": "Content-Type",
      "is_secret": false,
      "is_enabled": true,
      "has_value": true
    }
  ],
  "created_at": "2024-10-18T14:13:46.180Z",
  "updated_at": "2024-10-18T14:13:46.180Z"
}