Scenes

Create 3D scene

Changed on

Assemble a 3D scene with the Substance 3D API.

post/v1/scenes/assemble

Request

  • Base URL: https://s3d.adobe.io
  • URL: https://s3d.adobe.io/v1/scenes/assemble
  • Auth: HTTP bearer and API key in header x-api-key

Query parameters

waitboolean

Blocking mode (acts like a synchronous API call). Wait for the result before returning. ⚠️ Some operations are long, please be sure to configure your client timeout settings accordingly.

Request body

$schemastring uri

A URL to the JSON schema for this object.

encoding'glb' | 'gltf' | 'fbx' | 'usdz' | 'usda' | 'usdc' | 'obj' required

Encoding output format.

fileBaseNamestring required

Output filename.

Example request

{
  "encoding": "usdz",
  "fileBaseName": "scene",
  "scene": {
    "models": {
      "imports": [
        {
          "file": "WaterBottle.glb"
        },
        {
          "file": "WaterBottle.glb",
          "transform": {
            "trs": {
              "rotation": {
                "euler": [
                  30,
                  0,
                  0
                ]
              },
              "scale": [
                1,
                1,
                1
              ],
              "translation": [
                0.15,
                0,
                0
              ]
            }
          }
        }
      ]
    }
  },
  "sources": [
    {
      "url": {
        "url": "https://raw.githubusercontent.com/KhronosGroup/glTF-Sample-Models/master/2.0/WaterBottle/glTF-Binary/WaterBottle.glb"
      }
    }
  ]
}

Response

Accepted

$schemastring uri

A URL to the JSON schema for this object.

bugReportUrlstring required

URL to report a bug about this job.

errorstring

Potential error that happened during the job processing.

idstring required

Unique identifier of the job.

statusstring required

Status of the job. Can be not_started, running, succeeded, or failed.

urlstring required

URL to fetch/poll for the job result, in case the job is not finished yet.

Example response

{
  "$schema": "https://s3d.adobe.io/schemas/restv1beta.CreateSceneResponse.json",
  "result": {
    "outputSpace": {
      "$schema": "https://s3d.adobe.io/schemas/rest_base.Space.json"
    }
  }
}

Changes

  • 47f2ab72d0e5Revision changes
    • breaking

      request body became required

    • breaking

      the request property became not nullable

    • info

      the response property / became required for the status

  • 4408df4afbd5Revision changes
    • info

      added the new optional request property /