Create briefing episode
/v1/briefing-episodes
Signed-in sessionLaunch key product.briefingsOperation briefing_episode_create
Written and audio briefings from a person's work and memory: schedules, a listening queue, one player that keeps playing across the suite, a private feed and verified email delivery.
Headers
- X-Specify-Account-IdstringRequired
- The account the request acts in.
- X-Specify-Service-Tenancy-IdstringRequired
- The service tenancy the request acts in.
Body
- idempotencyKeystringRequired
- briefingRevisionIdstringRequired
- optionsobjectRequired
Returns
- schemaVersion1Required
- idstringRequired
- versionnumberRequired
- capabilitiesobject[]Required
- titlestringRequired
- createdAtnumberRequired
- updatedAtnumberRequired
- outputKind"episode" | "narration"Required
- editorialFormat"agent_interview" | "debate" | "monologue" | "panel" | "two_host" | "verbatim"Required
- castNamesstring[]Required
- targetMinutesnumberRequired
- durationMsnumber
- listenedMsnumber
- authoringState"approved" | "draft" | "drafting_script" | "needs_review" | "preparing_written" | "validating_script"Required
- renderState"assembling" | "cancel_requested" | "cancelled" | "failed" | "not_started" | "outcome_unknown" | "queued" | "quoted" | "ready" | "retry_wait" | "synthesizing" | "verifying"Required
- accessState"available" | "expired" | "permission_lost" | "source_revoked"Required
- deliveryState"cancelled" | "delivered" | "failed" | "not_requested" | "pending" | "pending_verification" | "sending"Required
- scheduleIdstring
- scheduleOccurrenceIdstring
- creditsobjectRequired
- briefingIdstringRequired
- briefingRevisionIdstringRequired
- optionsobjectRequired
- optionsHashstringRequired
- sourceSnapshotIdstringRequired
- audienceHashstringRequired
- scriptRevisionIdstring
- approvalIdstring
- renderIdstring
- completedSegmentsnumber
- totalSegmentsnumber
- transcriptCursorstring
- renderGenerationnumber
- retainUntilnumber
- sourceAsOfnumber
- quality"premium" | "standard"
- writtenRevisionnumber
- creatorNamestring
- renderVersionsobject[]
- narrationPlanobject
Errors
400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.