Ошибки и ограничения
Проверяйте HTTP-статус и содержимое ответа. Для генерации дополнительно важны поля type и error, а у запроса в очереди — status.
HTTP-статусы
| Код | Что означает и что делать |
|---|---|
| 200 / 201 | Запрос принят или выполнен. Проверьте результат в теле ответа |
| 400 | Неверные поля или ограничения операции. Проверьте code, message и параметры |
| 401 | Ошибка авторизации. Проверьте email и API-ключ |
| 402 | Недостаточно кредитов для обработки |
| 403 | Нет доступа: проверьте аккаунт и права на объект |
| 404 | Метод или объект не найден. Проверьте URL и идентификаторы |
| 429 | Слишком много запросов. Уменьшите частоту |
| 5xx | Сбой сервера или внешнего сервиса |
Каталог ошибок
GET /api/v1/errors/bad-request-codes
URL
https://app.helpfy.ai/api/v1/errors/bad-request-codes
Заголовки
| Заголовок | Значение |
|---|---|
Accept | application/json |
Параметры запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| — | — | Нет | Параметры не требуются. Авторизация для этого метода не заявлена. |
Пример запроса
curl --request GET "https://app.helpfy.ai/api/v1/errors/bad-request-codes" \
--header 'Accept: application/json'
Ответы
При успешном запросе возвращается HTTP 200 и каталог кодов. Полное описание метода.
Поля ошибки 400
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
statusCode | число | Да | HTTP-статус ошибки. |
error | строка | Да | Краткое техническое название ошибки. |
code | строка | Да, для структурированной ошибки | Код Helpfy AI для обработки в вашей программе. |
message | строка или массив строк | Да | Пояснение ошибки. |
details | массив или объект | Нет | Ошибки отдельных полей либо дополнительные сведения об ошибке. При валидации полей возвращается массив; например, при ошибке блока сценария — объект с node_id. |
Пример ошибки — HTTP 400
Сокращённый пример; значения условные.
{
"statusCode": 400,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": ["term must be shorter than or equal to 64 characters"]
}
Значения error, code и message показаны в том виде, в котором их может вернуть API. Текст message может быть на английском; для автоматической обработки используйте HTTP-статус и code.
Ограничения частоты
Общий лимит текущей реализации — 300 запросов за 60 секунд. Для отдельных методов и установок могут действовать другие ограничения. Если получен 429, делайте паузу; если сервер передал Retry-After, учитывайте его значение.
Повторные запросы
GET можно повторять с паузой и ограничением числа попыток. Перед повторным POST, PATCH или DELETE убедитесь, что операция ещё не выполнена: соединение могло прерваться после создания объекта или постановки запроса в очередь.
Для асинхронного ответа сохраняйте идентификатор запроса и проверяйте его состояние. При обращении в поддержку передайте метод, время и идентификатор запроса; API-ключ и заголовок Authorization не передавайте.