`VideoBackgroundRemovalJob`

Fields

errorobjectoptionalJobErrorVideoBackgroundRemovalErrorCode ↗

Failure information. Present once the job has FAILED.

Show 3 nested 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.

job_iduuidrequired

Stable identifier of the job and of the resource it produces.

resultobjectoptionalVideoBackgroundRemovalFiles ↗

The produced resource. Present once the job is COMPLETED.

Show 1 nested field

filesarray of objectrequiredFile ↗

Rendered background-removed file(s): one webm with alpha for vp9; the RGB video and the alpha matte (two files) for h264.

Show 4 nested fields

content_typestringoptional

The mime type of the file.

file_namestringoptional

The name of the file.

file_sizeintegeroptional

The size of the file in bytes.

urlstringrequired

The URL where the file can be downloaded from.

statusenumrequired

Current lifecycle state of the job.

PROCESSINGCOMPLETEDFAILEDCANCELLED

JSON Schema

VideoBackgroundRemovalJob.json

{
  "additionalProperties": false,
  "properties": {
    "error": {
      "description": "Failure information. Present once the job has FAILED.",
      "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"
    },
    "job_id": {
      "description": "Stable identifier of the job and of the resource it produces.",
      "format": "uuid",
      "type": "string"
    },
    "result": {
      "description": "The produced resource. Present once the job is COMPLETED.",
      "additionalProperties": false,
      "properties": {
        "files": {
          "description": "Rendered background-removed file(s): one webm with alpha for vp9; the RGB video and the alpha matte (two files) for h264.",
          "items": {
            "additionalProperties": false,
            "properties": {
              "content_type": {
                "description": "The mime type of the file.",
                "examples": [
                  "video/mp4"
                ],
                "type": "string"
              },
              "file_name": {
                "description": "The name of the file.",
                "type": "string"
              },
              "file_size": {
                "description": "The size of the file in bytes.",
                "format": "int64",
                "type": "integer"
              },
              "url": {
                "description": "The URL where the file can be downloaded from.",
                "type": "string"
              }
            },
            "required": [
              "url"
            ],
            "type": "object"
          },
          "type": [
            "array",
            "null"
          ]
        }
      },
      "required": [
        "files"
      ],
      "type": "object"
    },
    "status": {
      "description": "Current lifecycle state of the job.",
      "enum": [
        "PROCESSING",
        "COMPLETED",
        "FAILED",
        "CANCELLED"
      ],
      "type": "string"
    }
  },
  "required": [
    "job_id",
    "status"
  ],
  "type": "object"
}