briefs

Create a brief (the persisted intent the Director composes from)

Persist the video's intent — goal/audience/format/tone/CTA, beats with optional moment pinning ({mediaId, startSec, endSec}), captions (style + emphasis phrases), seeded graphics (carried VERBATIM as locked clips), exclusions (hard negatives the Director must never author), and gate config (holdAt / autoApprove). Then compose it with POST /projects/:id/compose {briefId} — every field is honored or the compose is refused loudly naming the field. The response carries the brief-time quote (compose + estimated render) to relay BEFORE any metered call.

post/v1/briefs

Request

  • Base URL: https://api.cueframe.ai
  • URL: https://api.cueframe.ai/v1/briefs
  • 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:write)
    • API key in header PAYMENT-SIGNATURE

Request body

projectIdstring required
namestring
goalstring required

What the video must accomplish.

audiencestring
platformstring
durationSecnumber

Target output duration. HONOR-OR-REFUSE: compose validates it against the beat-source window (±1.5s) and refuses a brief it cannot honor.

tonestring
ctastring
localestring

Output language (BCP-47 tag, e.g. 'es-419'): ALL on-screen copy + captions.

hookstring
captionstring
mustIncludesstring[]
referencesstring[]
exclusionsBriefExclusion[]

Response

Brief created.

idstring required
projectIdstring required
kind'authored' | 'clip' required

authored = create_brief; clip = minted by suggest_briefs from an AI clip suggestion.

sourceSuggestionIdstring

kind:'clip' provenance — the suggestion this Brief was minted from.

namestring
goalstring required

What the video must accomplish.

audiencestring
platformstring
durationSecnumber

Target output duration. HONOR-OR-REFUSE: compose validates it against the beat-source window (±1.5s) and refuses a brief it cannot honor.

tonestring
ctastring
localestring

Output language (BCP-47 tag, e.g. 'es-419'): ALL on-screen copy + captions.

hookstring
captionstring
mustIncludesstring[]
referencesstring[]
exclusionsBriefExclusion[]
createdAtnumber required
updatedAtnumber required

Changes

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