atlas

Export an ATLAS branch package

Changed on

Serializes a branch package (parent scene, hypothesis, delta state, and outcome projections) and returns it as an ExportAdapterResult. Requires operator+ role. Gated by the ENABLE_ATLAS_SPATIAL_RUNTIME feature flag — returns 503 FEATURE_DISABLED when the flag is off. Rate limited to 60 requests per minute per client.

post/atlas/branch/export

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/atlas/branch/export
  • Auth: HTTP bearer

Request body

parentSceneIdstring required

ID of the parent scene this branch derives from.

branchIdstring required

Unique identifier for this branch.

branchLabelstring

Human-readable label; defaults to branchId.

domainstring
branchedAtstring date-time

ISO-8601 timestamp; defaults to now.

hypothesisstring required

Description of the scenario or hypothesis being explored.

deltaStateobject

Map of state changes relative to the parent scene.

approvedBystring nullable
correlationIdstring nullable
metadataobject

Response

Branch package exported successfully.

formatstring required

Output format identifier (e.g. atlas.scene-snapshot.v1, atlas.openusd.v1).

payloadunknown required
sizeEstimateBytesinteger

Estimated payload size in bytes.

generatedAtstring date-time required

ISO-8601 timestamp when the export was generated.

adapterVersionstring required

Version string of the adapter that produced the result.

warningsstring[]

Non-fatal warnings emitted during serialization.

Changes