JobStatus

Current status and result of an asynchronous job

CreativeDesignGraphicsPhotographyVideo

Properties

Name	Type	Description
jobId	string	Unique identifier of the job
status	string	Current job status
created	string	ISO 8601 timestamp when the job was created
modified	string	ISO 8601 timestamp when the job was last modified
outputs	array	List of output files produced by a successful job
errors	array	List of errors if the job failed

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/JobStatus",
  "title": "JobStatus",
  "type": "object",
  "description": "Current status and result of an asynchronous job",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Unique identifier of the job",
      "example": "f54e0fcb-260b-47c3-b520-de0d17dc2b67"
    },
    "status": {
      "type": "string",
      "description": "Current job status",
      "enum": [
        "pending",
        "running",
        "succeeded",
        "failed"
      ],
      "example": "succeeded"
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the job was created",
      "example": "example_value"
    },
    "modified": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the job was last modified",
      "example": "example_value"
    },
    "outputs": {
      "type": "array",
      "description": "List of output files produced by a successful job",
      "items": {
        "$ref": "#/components/schemas/RenderOutput"
      }
    },
    "errors": {
      "type": "array",
      "description": "List of errors if the job failed",
      "items": {
        "$ref": "#/components/schemas/JobError"
      }
    }
  }
}