atlas

Export an ATLAS scene snapshot

Changed on

Returns a serialized JSON snapshot of an ATLAS scene as an ExportAdapterResult. Requires operator+ role (operator, ops, exec, admin, super_admin). 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.

get/atlas/snapshot/{sceneId}

Request

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

Path parameters

sceneIdstring required

Identifier of the ATLAS scene to snapshot.

Query parameters

domainstring

Domain that owns the scene (e.g. terra, vessels).

entityTypestring

Type of entity the scene represents.

entityIdstring

Entity identifier; defaults to sceneId when omitted.

Response

Snapshot 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