compositions

Get a project's composition

Required permission: projects:read

get/v1/projects/{id}/composition

Request

  • Base URL: https://api.cueframe.ai
  • URL: https://api.cueframe.ai/v1/projects/{id}/composition
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.cueframe.ai/api/auth/mcp/authorize, token URL https://api.cueframe.ai/api/auth/mcp/token, scopes: projects:read)
    • API key in header PAYMENT-SIGNATURE

Path parameters

idstring required

Query parameters

componentExecutionVersions'3'

The component execution versions this reader accepts, one parameter per version: 3, or 3 and 4 (native placements). Absent readers accept only the historical protocol.

includeDependencies'true' | 'false'

Return the immutable composition identity, project revision and shared v1 dependency expectations alongside the composition.

compositionIdstring

Read a SPECIFIC composition instead of the project's active one. Omit it and the active composition is returned. Pairs with composition_id on the apply op: an edit you can make to a second composition is one you can read back.

Response

The composition wire shape, or its observed dependency envelope when requested.

OR

Changes

No recorded changes to this operation across all 1 revision of this API.