Download OpenAPI specification:Download
Automation your 3D asset manipulation and render workflows
Create and start an automation job
Submit a job for execution
type required | string |
required | object [ 3 .. 60 ] properties Define a compute graph composed of several smaller operations. Object keys are treated as node-ids, and corresponding values are node definitions. Connections between nodes are created by referring a node-id in the inputs section of an individual node. Minimally, atleast 3 nodes are needed for the system to do something useful - a download node, a scene manipulation or render node and upload node. Currently, a maximum limit of 60 nodes is applied. Use the drop down menu to look at various node
schemas. Most nodes require some inputs and produce some
output. Input nodes are specified in the node property
inputs, and are typed to indicate whether the input node
should be an image, scene, model, or a any file. Some
nodes expose parameters. The output of each node
operation is specified in the outputs key. Most nodes
produce a single type of output file, but some can be
configured, for example, Check out example payloads for inspiration on how to author your own jobs. The following string |
result | object Output results, if any |
{- "type": "multi.beta",
- "spec": {
- "4892f802-f72d-4a85-9e87-43a42aa193de": {
- "type": "https.download",
- "output": {
- "type": "scene",
- "extension": ".dn"
}
}, - "664e08e7-a454-41c9-afe8-744ac5d6e2dd": {
- "type": "https.download",
- "output": {
- "type": "image",
- "extension": ".png"
}
}, - "62566faf-ef36-4818-9b61-dc3f5ae8af69": {
- "type": "https.azure.upload",
- "inputs": {
- "file": "e5748b9e-1aea-4d45-ae03-1ce3c2a876df"
},
}, - "e5748b9e-1aea-4d45-ae03-1ce3c2a876df": {
- "type": "scene.setBackgroundTexture",
- "output": {
- "type": "scene",
- "extension": ".ssg"
}, - "inputs": {
- "scene": "4892f802-f72d-4a85-9e87-43a42aa193de",
- "image": "664e08e7-a454-41c9-afe8-744ac5d6e2dd"
}
}
}
}
{- "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}
Shows current job status
jobId required | string <uuid> (jobId) Job Id |
{- "type": "multi.beta",
- "result": { },
- "spec": {
- "property1": {
- "type": "scene.setDecalOrMaterialTexture",
- "output": {
- "type": "scene",
- "extension": ".ssg"
}, - "inputs": {
- "scene": "string",
- "image": "string"
}, - "parameters": {
- "decalOrMaterialId": "string",
- "artboardId": 0
}, - "status": {
- "state": "WAITING",
- "timeStarted": "2019-08-24T14:15:22Z",
- "timeCompleted": "2019-08-24T14:15:22Z",
- "allocCpu": 0,
- "usedCpu": 0,
- "usedMem": 0,
- "ext": "string",
- "size": 0
}
}, - "property2": {
- "type": "scene.setDecalOrMaterialTexture",
- "output": {
- "type": "scene",
- "extension": ".ssg"
}, - "inputs": {
- "scene": "string",
- "image": "string"
}, - "parameters": {
- "decalOrMaterialId": "string",
- "artboardId": 0
}, - "status": {
- "state": "WAITING",
- "timeStarted": "2019-08-24T14:15:22Z",
- "timeCompleted": "2019-08-24T14:15:22Z",
- "allocCpu": 0,
- "usedCpu": 0,
- "usedMem": 0,
- "ext": "string",
- "size": 0
}
}
}, - "metadata": {
- "timeCreated": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "status": {
- "state": "WAITING",
- "completion": 1,
- "timeLastChecked": "2019-08-24T14:15:22Z",
- "messages": [
- {
- "timeGenerated": "2019-08-24T14:15:22Z",
- "type": "string",
- "message": "string"
}
]
}
}