Api
One-call agent context: composition + media + transcript + brand
Everything an authoring agent needs to open a project, in ONE read: the active composition (with its format and markers hoisted), the org's media pool with a `hasTranscript` flag per item, the first transcribed item's word-timed transcript, and the brand kit bound to the project. Replaces the get_composition + get_media_context + get_profile opening sequence. A freshly created project reads back with `composition: null` — that is the empty state, not an error; 404 means the project doesn't exist for your org. Transcript BODIES are never inlined per media item — read another item's with GET /v1/media/{id}/transcript, and its faces/beat/word grids with GET /v1/media/{id}/context.
AuthorizationBearer <token>
API key auth. Prefix cf_live_ for production orgs, cf_test_ for sandbox.
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/projects/string/context"{ "composition": { "v": 1, "format": { "aspectRatio": "16:9", "fps": 24, "resolution": "hd", "platform": "string" }, "tracks": [ { "id": "string", "kind": "video", "name": "string", "enabled": true, "contents": [ { "id": "string", "startTime": 0, "duration": 1, "source": { "kind": "media", "mediaId": "string", "trim": { "start": 0, "end": 0 }, "excludedRanges": [ { "start": 0, "end": 0, "reason": "string" } ], "volume": 0, "muted": true, "playbackRate": 1, "sync": "video", "kenBurns": "in", "volumeDb": 0, "fadeInMs": 0, "fadeOutMs": 0, "loop": true, "audioRole": "sfx", "duck": { "duckDb": 0, "attackMs": 0, "releaseMs": 0, "windows": [ { "startMs": 0, "endMs": 0 } ] }, "anchor": { "clipId": "string", "offsetMs": 0 }, "reframe": { "segments": [ { "startSec": 0, "endSec": 1, "focus": { "mode": "frame-center" }, "intent": "string", "zoom": 0.1, "ease": { "in": 0, "out": 0 }, "bias": { "x": -0.3, "y": -0.3 } } ] } }, "kind": "video", "opacity": 0, "scale": 1, "rotation": 0, "position": { "x": 0, "y": 0 }, "region": { "x": 0, "y": 0, "w": 1, "h": 1 }, "fit": "cover", "effects": [ { "primitiveId": "string", "params": { "property1": null, "property2": null } } ], "transitionIn": { "type": "string", "duration": 1 } } ] } ], "markers": [ { "id": "string", "startTime": 0, "endTime": 0, "kind": "string", "name": "string", "metadata": { "property1": null, "property2": null } } ], "captions": { "segments": [ { "words": [ { "text": "string", "startMs": 0, "endMs": 0, "emphasis": true, "annotate": "circle" } ] } ], "style": { "fontFamily": "string", "fontSize": 1, "fontWeight": 100, "color": "string", "highlightColor": "string", "backgroundColor": "string", "plate": "glass", "position": "top", "textTransform": "none", "emphasisColor": "string", "emphasisGradient": "string", "emphasisScale": 1, "emphasisFontFamily": "string", "emphasisFontWeight": 100, "emphasisTextTransform": "none", "emphasisLetterSpacing": 0, "emphasisFontStyle": "normal", "entrance": "none", "entranceMs": 0, "entranceStaggerMs": 0, "exitMs": 0, "emphasisPlate": true, "emphasisPlateColor": "string", "emphasisPlateTextColor": "string", "emphasisPlateAltColor": "string", "emphasisPlateAltTextColor": "string", "emphasisPlateRadius": 0, "emphasisPlatePadX": 0, "emphasisPlatePadY": 0, "annotationColor": "string", "maxWidthPercent": 1 } }, "license": { "type": "string", "source": "string", "notes": "string" }, "accessibility": { "audioDescriptionTrackId": "string", "captionsTrackId": "string", "signLanguageTrackId": "string", "notes": "string" } }, "format": { "aspectRatio": "16:9", "fps": 24, "resolution": "hd", "platform": "string" }, "media": [ { "id": "string", "name": "string", "kind": "string", "durationSec": 0, "hasTranscript": true } ], "transcript": { "status": "ready", "mediaId": "string", "words": [ { "text": "string", "start": 0, "end": 0 } ] }, "brandKit": { "id": "string", "name": "string", "description": "string", "tagline": "string", "colors": { "property1": "string", "property2": "string" }, "extraColors": [ { "name": "string", "value": "string" } ], "fonts": { "heading": { "family": "string", "weight": 0 }, "body": { "family": "string", "weight": 0 } }, "voiceGuidelines": "string", "captions": { "sync": true, "profile": { "property1": null, "property2": null } }, "motion": { "duration": 0, "easing": "linear", "entrance": "none", "staggerMs": 0, "exitMs": 0 }, "logo": { "src": "string", "alt": "string", "placement": "tl", "sizePct": 0 }, "intro": { "kind": "card", "src": "string", "title": "string", "subtitle": "string", "durationMs": 0 }, "outro": { "kind": "card", "src": "string", "title": "string", "subtitle": "string", "durationMs": 0 }, "watermark": { "src": "string", "opacity": 0, "placement": "tl" }, "spacing": { "base": 0, "lg": 0, "sm": 0 }, "sizing": { "fontSizeHeading": 0, "fontSizeBody": 0, "fontSizeLabel": 0, "borderRadius": 0 }, "audio": { "sfxIntensity": "off", "musicEnabled": true, "musicMood": "string", "sonicLogo": { "ref": "string", "placement": "intro", "offsetMs": 0 }, "uiSoundSet": { "tick": "string", "pop": "string", "impact": "string", "confirm": "string", "error": "string", "whoosh": "string", "riser": "string" }, "bedStyle": { "bedId": "string", "genre": "string", "bpmRange": { "min": 0, "max": 0 } }, "ambiencePreference": { "ref": "string" } }, "exemplarKeys": [ "string" ], "contactSheetKey": "string", "motifs": [ { "id": "string", "observed": "string", "body": { "kind": "card", "html": "string", "tokens": { "property1": "string", "property2": "string" } }, "motion": { "preset": "fade-up", "enterMs": 0, "exitMs": 0, "staggerMs": 0, "confidence": "high" }, "role": "title-card", "zone": { "x": 0, "y": 0, "w": 0, "h": 0 }, "evidence": [ 0 ], "diffScore": 0, "coverage": "reproduced", "skipReason": "string" } ], "styleRubric": "string", "density": { "graphicsPerMin": 0, "maxSimultaneous": 1 }, "inspiration": { "sources": [ "string" ], "extractedAt": 0, "extractionVersion": "string" }, "createdAt": "string", "updatedAt": "string" }, "markers": [ { "id": "string", "startTime": 0, "endTime": 0, "kind": "string", "name": "string", "metadata": { "property1": null, "property2": null } } ]}{ "error": { "code": "string", "message": "string", "details": { "property1": null, "property2": null } }}{ "error": { "code": "string", "message": "string", "details": { "property1": null, "property2": null } }}{ "x402Version": 2, "accepts": [ {} ], "error": "string"}{ "error": { "code": "string", "message": "string", "details": { "property1": null, "property2": null } }}{ "error": { "code": "string", "message": "string", "details": { "property1": null, "property2": null } }}{ "error": { "code": "string", "message": "string", "details": { "property1": null, "property2": null } }}{ "error": { "code": "string", "message": "string", "details": { "property1": null, "property2": null } }}