Scenes

Convert 3D files

Changed on

Convert a 3D file into another 3D format with the Substance 3D API.

post/v1/scenes/convert

Request

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

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

Output format.

modelEntrypointstring

Conversion usually takes the first file that's considered a valid 3D model. Define this entry point to disambiguate when there are multiple options.

Example request

{
  "format": "glb",
  "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.ModelConvertResponse.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

  • b887565bc6d4Revision changes
    • info

      added the new optional query request parameter wait

    • info

      added the required property // to the response with the status