components

List component catalog (defaults + installed)

Discover the built-in primitive catalog (87 primitives + 7 scenes) plus your installed components. Narrow with facet filters (category, kind, tier, useCase, mood) or free-text (q / intent); when ANY filter is set, results are ordered recommended-tier-first. With NO limit the WHOLE (filtered) catalog returns in one page — pass limit only to page. Each entry carries a placement hint telling you exactly how to author it on the timeline.

get/v1/components

Request

  • Base URL: https://api.cueframe.ai
  • URL: https://api.cueframe.ai/v1/components
  • 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

Query parameters

projection'component-library'
origin'builtin' | 'library'

With component-library projection, builtin selects immutable builtin cards; library selects the authenticated org's exact serving datastore.

libraryKind'definition' | 'preset' | 'recipe'
category'text' | 'effects' | 'transitions' | 'layouts' | 'backgrounds' | 'ui-blocks' | 'scenes'

Filter to one category bucket (text|effects|transitions|layouts|backgrounds|ui-blocks|scenes).

kind'component' | 'transition' | 'scene'

Filter by render kind (component|transition|scene).

tier'recommended' | 'standard' | 'niche'

Filter by curation tier (recommended|standard|niche).

useCase'intro' | 'outro' | 'full-scene' | 'title-over-footage' | 'transition' | 'background' | 'grade' | 'emphasis' | 'explainer' | 'social-cut'

Filter to entries whose useCase includes this edit role (e.g. intro, title-over-footage, grade).

moodstring

Filter to entries whose mood tags include this value (e.g. cinematic, minimal).

qstring

Free-text match across id/name/description/intent/useWhen/tags/mood. Recommend-orders results.

intentstring

Alias of q framed as recommend-by-intent (e.g. intent=intro). Recommend-orders results.

limitinteger

Page size (1..100). Omit to return the whole filtered catalog in one page.

afterstring

Opaque cursor from a previous page's nextCursor (forward-only).

Response

Component catalog (filtered + recommend-ordered).

OR

Changes

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