Integrations

REST Examples

Copy-paste oriented sketches of common platform API calls.

Create a processing job from a source URL

POST /api/models

Authorization: Bearer bg_live_…

Content-Type: application/json

{ "externalId": "asset_48392", "sourceUrl": "https://your-platform.example/models/asset_48392.step" }

Create a secure viewer from an existing model URL

POST /api/viewer

Authorization: Bearer bg_live_…

Content-Type: application/json

{ "externalId": "asset_48392", "modelUrl": "https://your-platform.example/models/asset_48392.glb" }

Poll job status

GET /api/jobs/{jobId}

Authorization: Bearer bg_live_…

Look for a terminal status and viewer URL fields before creating storefront embeds.

Create a share token

POST /api/models/{jobId}/share

Authorization: Bearer bg_live_…

Response includes a token you can map to /share/{token} or /embed/{token}.

Contract note

Exact paths, payloads, and field names are finalized in your API contract / OpenAPI package. Use these examples as integration sketches, then confirm against the spec issued for your environment.