API
← All schemas

JobErrorVideoBackgroundRemovalErrorCode

Fields

codeenumrequired

Stable, machine-readable failure code for this job type.

input_validationcontent_moderationinvalid_fileaudio_too_longtransload_failedgeneration_failedtimeout
detailsarray of objectoptionalJobErrorDetail

Optional structured failure details.

Show 3 nested fields
fieldstringoptional

Dotted path to the offending input, when applicable.

messagestringrequired

Human-readable explanation of this detail.

typestringrequired

The category of this detail entry.

messagestringrequired

Human-readable failure message.

JSON Schema

JobErrorVideoBackgroundRemovalErrorCode.json
{
  "additionalProperties": false,
  "properties": {
    "code": {
      "description": "Stable, machine-readable failure code for this job type.",
      "enum": [
        "input_validation",
        "content_moderation",
        "invalid_file",
        "audio_too_long",
        "transload_failed",
        "generation_failed",
        "timeout"
      ],
      "type": "string"
    },
    "details": {
      "description": "Optional structured failure details.",
      "items": {
        "additionalProperties": false,
        "properties": {
          "field": {
            "description": "Dotted path to the offending input, when applicable.",
            "type": "string"
          },
          "message": {
            "description": "Human-readable explanation of this detail.",
            "type": "string"
          },
          "type": {
            "description": "The category of this detail entry.",
            "type": "string"
          }
        },
        "required": [
          "type",
          "message"
        ],
        "type": "object"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "message": {
      "description": "Human-readable failure message.",
      "type": "string"
    }
  },
  "required": [
    "code",
    "message"
  ],
  "type": "object"
}