API · Presentations · 2 min read

Get a presentation

The open creation, to resume it from a new session.

GET /v1/presentations/{presentationId} · API v1 · versioning

The open creation as it stands, for its owner picking it up from a new agent session: every slide published so far as indexHtml, which slides have narration, the voice and speed they were narrated with, the assets it holds, the owner's answer to every survey so far, and live.revision. Send that revision back as baseRevision on the next append; an append written against an older one is refused with LIVE_REVISION_CONFLICT. Reading changes nothing. API-key callers only.

Authentication

Send an API key as Authorization: Bearer bisque_live_…. Keys come from bisque.cloud/setup/keys; see Authentication.

Request

ParameterInMeaning
presentationIdpath, required

Example

curl -X GET https://bisque.cloud/v1/presentations/{presentationId} \
  -H "Authorization: Bearer $BISQUE_API_KEY"

Response

200: The live creation.

Errors:

  • 401: Missing or invalid credential.
  • 403: Another account opened this creation.
  • 404: Not a presentation you can change, or not live: finalized or never opened live.
  • 409: Another publish superseded this creation.

Other endpoints

PageCallWhat it does
Create a presentationPOST /v1/presentationsPut the slides up now and narrate them one at a time.
Add slidesPATCH /v1/presentations/{presentationId}Append sections while the creation is open.
Update a slidePATCH /v1/presentations/{presentationId}/slides/{slideKey}Give one slide its narration after the MP3 is uploaded.
Wait for an answerGET /v1/presentations/{presentationId}/surveys/{surveyId}/responseHold for the viewer's answer to a question on a slide.
FinalizePOST /v1/presentations/{presentationId}:finalizeClaim the version. Slides still without audio stay silent.
Read as textGET /api/presentations/contextAny shared presentation as a transcript. No credential needed.