removedOutput schema / properties / batchId
Removed value: -{
- "anyOf": [
- {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "The batch it joined; null for a job on its own"
-}
removedOutput schema / properties / creditCost
Removed value: -{
- "description": "Credits the render spends when it succeeds",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
-}
removedOutput schema / properties / error
Removed value: -{
- "description": "Why the render failed",
- "type": [
- "string",
- "null"
- ]
-}
removedOutput schema / properties / flowId
Removed value: -{
- "anyOf": [
- {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
-}
removedOutput schema / properties / id
Removed value: -{
- "description": "jobId for run_job and get_job",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
-}
addedOutput schema / properties / jobs
Added value: +{
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "batch": {
+ "anyOf": [
+ {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The batch it is in; null for a job on its own"
+ },
+ "creditCost": {
+ "description": "Credits the render spends when it succeeds",
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+ },
+ "error": {
+ "description": "Why the render failed",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "file": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "contentType": {
+ "type": "string"
+ },
+ "creativeId": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "fileName": {
+ "type": "string"
+ },
+ "height": {
+ "anyOf": [
+ {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "sizeBytes": {
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+ },
+ "url": {
+ "description": "Link to the rendered file",
+ "type": "string"
+ },
+ "width": {
+ "anyOf": [
+ {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "required": [
+ "creativeId",
+ "url",
+ "fileName",
+ "contentType",
+ "sizeBytes",
+ "width",
+ "height"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The rendered file; null until the job succeeds"
+ },
+ "flow": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The flow it renders as a video, if it does"
+ },
+ "id": {
+ "description": "jobId for run_job, get_job and update_job",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "modifications": {
+ "anyOf": [
+ {
+ "additionalProperties": {},
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The values it renders, by layer; null for a job made in the Kalpana app"
+ },
+ "output": {
+ "additionalProperties": false,
+ "properties": {
+ "format": {
+ "description": "File format the job renders to",
+ "enum": [
+ "png",
+ "jpeg",
+ "webp",
+ "pdf",
+ "mp4",
+ "gif",
+ "webm",
+ "mov"
+ ],
+ "type": "string"
+ },
+ "kind": {
+ "description": "image for still renders (png, jpeg, webp, pdf); video for mp4, gif, webm or mov",
+ "enum": [
+ "image",
+ "video"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "format",
+ "kind"
+ ],
+ "type": "object"
+ },
+ "page": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The page it renders; null for a video"
+ },
+ "status": {
+ "description": "pending waits for run_batch, processing is rendering, success has rendered, failed has a render error, cancelled was stopped by cancel_batch or cancel_job (final, not charged)",
+ "enum": [
+ "pending",
+ "processing",
+ "success",
+ "failed",
+ "cancelled"
+ ],
+ "type": "string"
+ },
+ "template": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "status",
+ "template",
+ "page",
+ "flow",
+ "batch",
+ "modifications",
+ "output",
+ "creditCost",
+ "error",
+ "file"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}
removedOutput schema / properties / output
Removed value: -{
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "contentType": {
- "type": "string"
- },
- "creativeId": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "fileName": {
- "type": "string"
- },
- "height": {
- "anyOf": [
- {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- {
- "type": "null"
- }
- ]
- },
- "sizeBytes": {
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- },
- "url": {
- "description": "Link to the rendered file",
- "type": "string"
- },
- "width": {
- "anyOf": [
- {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "required": [
- "creativeId",
- "url",
- "fileName",
- "contentType",
- "sizeBytes",
- "width",
- "height"
- ],
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "description": "The rendered file; null until the job succeeds"
-}
removedOutput schema / properties / outputFormat
Removed value: -{
- "description": "File format the job renders to",
- "enum": [
- "png",
- "jpeg",
- "webp",
- "pdf",
- "mp4",
- "gif",
- "webm",
- "mov"
- ],
- "type": "string"
-}
removedOutput schema / properties / outputKind
Removed value: -{
- "description": "image for still renders (png, jpeg, webp, pdf); video for mp4, gif, webm or mov",
- "enum": [
- "image",
- "video"
- ],
- "type": "string"
-}
removedOutput schema / properties / pageId
Removed value: -{
- "anyOf": [
- {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
-}
changedOutput schema / properties / status / description
Previous value: -"pending waits for run_batch, processing is rendering, success has rendered, failed has a render error, cancelled was stopped by cancel_batch or cancel_job (final, not charged)"New value: +"processing while any job renders (get_job a few seconds later), pending while any waits for run_job, done when each has finished"
changedOutput schema / properties / status / enum
Previous value: -[
- "pending",
- "processing",
- "success",
- "failed",
- "cancelled"
-]New value: +[
+ "processing",
+ "pending",
+ "done"
+]
removedOutput schema / properties / templateId
Removed value: -{
- "anyOf": [
- {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
-}
changedOutput schema / required
Previous value: -[
- "id",
- "status",
- "batchId",
- "templateId",
- "pageId",
- "flowId",
- "outputKind",
- "outputFormat",
- "creditCost",
- "error",
- "output"
-]New value: +[
+ "status",
+ "jobs"
+]