Справочник ошибок

FaceSwap API возвращает корректный HTTP-статус в зависимости от типа ошибки, а детали — в теле ответа в поле error. При успешном сценарии статус — 200.

HTTP-статусы

HTTP	Когда возникает
400	Некорректный запрос: не передан обязательный параметр (`sourceImage`, `faceImage`, `taskId`), неверный формат изображения (не http(s)-URL и не base64 PNG/JPEG), некорректный `webhook`, либо задача с указанным `taskId` не найдена.
401	Отсутствует или неверный API-ключ.
402	Недостаточно средств для выполнения запроса.
500	Внутренняя ошибка сервиса.

Формат тела ошибки

Ошибка приходит в поле error. Используются две формы:

1. Основная (валидация, лимиты, конфигурация):

{
  "error": {
    "message": "'sourceImage' is a required property",
    "type": "invalid_request_error",
    "param": null,
    "code": null
  }
}

2. Для ошибок списания и постановки задачи (code — внутренний код, см. Справочник ошибок CreativeLab):

{
  "error": {
    "code": 5,
    "message": "Insufficient balance, check account balance."
  }
}

Примеры ответов

{
  "error": {
    "message": "'sourceImage' is a required property",
    "type": "invalid_request_error",
    "param": null,
    "code": null
  }
}

{
  "error": {
    "message": "The task '65819c...' does not exist",
    "type": "invalid_request_error",
    "param": null,
    "code": "task_not_found"
  }
}

{
  "error": {
    "message": "Organization balance is too low to use API",
    "type": "insufficient_balance_error",
    "param": null,
    "code": null
  }
}

{
  "error": {
    "code": 500,
    "message": "Internal exception. We already working on this issue."
  }
}