ResourceVideoBackgroundRemovalJob
Fields
Show 4 nested fields
Failure information. Present once the job has FAILED.
Show 3 nested fields
codeenumrequiredStable, machine-readable failure code for this job type.
input_validationcontent_moderationinvalid_fileaudio_too_longtransload_failedgeneration_failedtimeoutOptional structured failure details.
Show 3 nested fields
fieldstringoptionalDotted path to the offending input, when applicable.
messagestringrequiredHuman-readable explanation of this detail.
typestringrequiredThe category of this detail entry.
messagestringrequiredHuman-readable failure message.
job_iduuidrequiredStable identifier of the job and of the resource it produces.
The produced resource. Present once the job is COMPLETED.
Show 1 nested field
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_typestringoptionalThe mime type of the file.
file_namestringoptionalThe name of the file.
file_sizeintegeroptionalThe size of the file in bytes.
urlstringrequiredThe URL where the file can be downloaded from.
statusenumrequiredCurrent lifecycle state of the job.
PROCESSINGCOMPLETEDFAILEDCANCELLEDJSON Schema
ResourceVideoBackgroundRemovalJob.json
{
"additionalProperties": false,
"properties": {
"$schema": {
"description": "A URL to the JSON Schema for this object.",
"examples": [
"https://api.veed.io/schemas/ResourceVideoBackgroundRemovalJob.json"
],
"format": "uri",
"readOnly": true,
"type": "string"
},
"data": {
"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"
}
},
"required": [
"data"
],
"type": "object"
}