Base URL:
The canonical machine-readable contract is the authenticated partner OpenAPI document. Retrieve it with any active organization key.
| Method |
Path |
Purpose |
POST |
/v1/image-assets |
Validate and upload an image |
| Method |
Path |
Purpose |
POST |
/v1/scenes |
Accept scene reconstruction |
GET |
/v1/scenes?externalRef={externalRef} |
Recover one exact scene |
GET |
/v1/scenes/{sceneId} |
Read scene metadata |
POST |
/v1/scenes/{sceneId}/edits |
Accept a high-level edit |
DELETE |
/v1/scenes/{sceneId} |
Delete and revoke scene access |
GET |
/v1/operations/{operationId} |
Read create or edit status |
| Method |
Path |
Purpose |
POST |
/v1/embed-sessions |
Mint an origin-bound hosted studio URL |
DELETE |
/v1/embed-sessions/{embedSessionId} |
Revoke a session |
| Method |
Path |
Purpose |
GET |
/v1/reference-packages/{referencePackageId} |
Retrieve paired media metadata and signed URLs |
POST |
/v1/reference-packages/{referencePackageId}/ack |
Acknowledge durable receipt |
GET |
/v1/scenes/{sceneId}/pending-reference-packages |
Recover unacknowledged IDs |
- Accepted scene work:
202 Accepted
- Image and embed-session creation:
201 Created
- Reads:
200 OK
- Deletion, revocation, and acknowledgment:
204 No Content
- Every resource and error response:
Cache-Control: private, no-store
- Processing and retryable contention:
Retry-After
The API changes additively within /v1. Ignore unknown response fields. A breaking HTTP or host-message change uses a new coordinated version.