Adobe Substance 3D Automation Service (1.0.0)

Download OpenAPI specification:Download

License: Proprietary

Automation your 3D asset manipulation and render workflows

Job Management

REST API endpoints for creating, querying and canceling jobs

Create a job

Create and start an automation job

Authorizations:
(ApiKeyAuthBearerAuthImsOrgAuth)
Request Body schema: application/json

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, scene.render can produce a .png or a .psd file.

Check out example payloads for inspiration on how to author your own jobs.

The following string property name* indicates that you can enter any valid JSON object key, and that is treated as a node identifier.

result
object

Output results, if any

Responses

Request samples

Content type
application/json
Example
{}

Response samples

Content type
application/json
{
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}

Show job status

Shows current job status

Authorizations:
(ApiKeyAuthBearerAuthImsOrgAuth)
path Parameters
jobId
required
string <uuid> (jobId)

Job Id

Responses

Response samples

Content type
application/json
{
  • "type": "multi.beta",
  • "result": { },
  • "spec": {
    },
  • "metadata": {
    },
  • "status": {
    }
}

Cancel a job, if running

Cancels a job, if running

Authorizations:
(ApiKeyAuthBearerAuthImsOrgAuth)
path Parameters
jobId
required
string <uuid> (jobId)

Job Id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}