Skip to main content
POST
Read coherent domain projections

Authorizations

Authorization
string
header
required

Gumnut API key (apikey_...) sent as a Bearer token in the Authorization header. Create and manage keys in the Gumnut app, or with the API key endpoints while signed in to it.

Body

application/json
mode
string
required

Read exactly the explicit roots and their required dependencies

Allowed value: "roots"
library_id
string
required

Explicit live library binding for every root and dependency

Required string length: 1 - 255
profile
ProjectionProfile · object
required

Versioned source semantics to project

keys
(EntityProjectionKey · object | AlbumAssetProjectionKey · object)[]
required

Nonempty unique root selection; exceeding capacity returns 413

Required array length: 1 - 100 elements

Response

Successful Response

semantic_schema_version
integer
required

Projection bundle semantic schema version

snapshot_id
string<uuid>
required

Diagnostic read identifier; cannot retrieve an old snapshot

profile_hash
string
required

Lowercase SHA-256 of the canonical complete semantic manifest

scope
GumnutProjectionScope · object
required

Current library scope captured with the content

roots
ProjectionRootResult · object[]
required

Exact selected root results, sorted by kind and stable key

projections
(CurrentUserProjection · object | AssetProjection · object | PersonProjection · object | FaceProjection · object | StackProjection · object | AlbumProjection · object | AlbumAssetProjection · object)[]
required

Deduplicated complete transitive closure, sorted by kind and stable key, including the principal

baseline_start
null
required

Null for explicit roots reads

enumeration
null
required

Null for explicit roots reads