SpecifyDocs

Get briefing queue item

/v1/briefing-queues/{listenerPrincipalId}/items/{itemId}

Signed-in session or agent keyLaunch key product.briefingsOperation briefing_queue_item_get

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.

Path parameters

listenerPrincipalIdstringRequired
itemIdstringRequired

Returns

createdAtnumber
finishedAtnumber
reasonCode"AI_BALANCE_EXHAUSTED" | "AUDIO_EXPIRED" | "CHECKING_PROVIDER_RESULT" | "CONSENT_REVOKED" | "NEEDS_RENDER_APPROVAL" | "PERMISSION_LOST" | "PLAYBACK_UNAVAILABLE" | "QUEUE_BUDGET_EXCEEDED" | "RENDER_FAILED" | "SCHEDULE_BUDGET_EXCEEDED" | "SOURCE_REVOKED" | "WAITING_FOR_RENDER_SLOT" | "SOURCE_REVOKED"
targetobject
renderIdstring
episodeIdstring
outputKind"episode" | "narration"
durationMsnumber
sourceAsOfnumber
writtenRevisionnumber
castNamesstring[]
settledAudioCreditsstring
schemaVersion1
itemIdstring
versionnumber
queueState"active" | "blocked" | "completed" | "pending" | "removed" | "skipped" | "withdrawn" | "withdrawn"
addedBystring
ranknumber
sequencenumber
titlestring
readyboolean
errorobject
pollAfterMsnumber
submissionIdstring
status"blocked" | "ready" | "removed" | "waiting" | "blocked"

Errors

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