Scenes

Describe 3D scene

Changed on

Describe a 3D scene.

post/v1/scenes/describe

Request

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

sceneFilestring

Path to the scene file in sources. If the value is null, the first found scene file will be used.

Example request

{
  "sources": [
    {
      "url": {
        "url": "https://cdn.substance3d.com/v2/files/public/stepladder.usdz"
      }
    }
  ]
}

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.SceneDescResponse.json"
}

Changes