Scenes

Render 3D object (basic version)

Changed on

Render a 3D object (basic version) with the Substance 3D API.

post/v1/scenes/render-basic

Request

  • Base URL: https://s3d.adobe.io
  • URL: https://s3d.adobe.io/v1/scenes/render-basic
  • 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.

cameraNamestring

If set, this camera is used to perform the render. The camera has to be defined in the scene.

Example request

{
  "scene": {
    "modelFile": "WaterBottle.glb"
  },
  "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.RenderModelResponse.json",
  "result": {
    "outputSpace": {
      "$schema": "https://s3d.adobe.io/schemas/rest_base.Space.json"
    }
  }
}

Changes

  • c56d1c657fa8Revision changes
    • breaking

      the response property / became optional for the status

  • 47f2ab72d0e5Revision changes
    • breaking

      request body became required

    • breaking

      the request property became not nullable

    • info

      the response property / became required for the status