List briefing episodes

GET/v1/briefing-episodes

Signed-in sessionLaunch key product.briefingsOperation briefing_episodes_list

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.

Query parameters

state"assembling" | "cancel_requested" | "cancelled" | "failed" | "not_started" | "outcome_unknown" | "queued" | "quoted" | "ready" | "retry_wait" | "synthesizing" | "verifying"
cursorstring
outputKind"episode" | "narration"
scheduleIdstring
limitnumber

Returns

schemaVersion1Required
itemsobject[]Required
nextCursornull | stringRequired

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.

curl "$SPECIFY_API_ORIGIN/v1/briefing-episodes" \ -H "Authorization: Bearer $SPECIFY_SESSION_TOKEN" \ -H "X-Specify-Account-Id: <accountId>" \ -H "X-Specify-Service-Tenancy-Id: <serviceTenancyId>"

{ "result": { "schemaVersion": 1, "items": [ { "schemaVersion": 1, "id": "<id>", "version": 1, "capabilities": [ { "action": "<action>", "allowed": true } ], "title": "<title>", "createdAt": 1, "updatedAt": 1, "outputKind": "episode", "editorialFormat": "agent_interview", "castNames": [ "<castName>" ], "targetMinutes": 1, "authoringState": "approved", "renderState": "assembling", "accessState": "available", "deliveryState": "cancelled", "credits": { "written": "<written>", "script": "<script>", "audio": "<audio>" } } ], "nextCursor": "<nextCursor>" } }

List briefing episodes

Headers

Query parameters

Returns

Errors