briefs

Edit a brief

Partial update. While an ACTIVE compose job references this brief the edit is refused (409 conflict) — finish, resume, or abandon the job first; the Director never has its input edited out from under it.

patch/v1/briefs/{id}

Request

  • Base URL: https://api.cueframe.ai
  • URL: https://api.cueframe.ai/v1/briefs/{id}
  • 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

Path parameters

idstring required

Request body

namestring
goalstring

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

Updated brief.

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.