get_presentation_spec
Get the authoring spec
Fetch the html-presentation/v1 authoring contract: document structure, the dual landscape/vertical layout rule, and the narration markup that makes slides speak. Call this BEFORE authoring for create_presentation — documents written without it publish with missing audio.
無需輸入參數。
create_presentation
Create narrated presentation
Generate a narrated presentation from an html-presentation/v1 document. BEFORE authoring, call get_presentation_spec and follow it exactly — slides without its narration markup publish SILENT. Returns a presentationId and the watch URL. Narration runs in the background and the inline player tracks it on its own, so reply to the user as soon as this returns and do not call get_presentation_status unless the user asks whether it is done.
輸入參數slugaudiotitleassetsdryRunhandlevoiceIddesignMdmadeWithcontextMdindexHtml必填visibility另有 3 個
publish_narrated_presentation
Deprecated — use create_presentation with `audio`
DEPRECATED: call create_presentation with an `audio` array instead — it is the same thing in one call, and the slides are viewable while the narration lands. Publish an html-presentation/v1 document using audio YOU synthesized locally (e.g. with `bisque-voice`) — free, unlimited, and works on macOS, Linux and Windows. Send each narrated slide's word timings and MP3 metadata; the server assembles presentation.json (recomputing cues from your narration markers) and returns one upload URL per MP3. Then PUT each file and POST the returned completeUrl with the returned `files` array. RE-PUBLISHING: `audio` is optional — any narrated slide you omit reuses the audio from the last publish whenever its narration text and speechSpeed are unchanged, so an HTML-only edit needs no synthesis at all. The response reports `reused`, `synthesized`, and `staleSlides` (narrated slides whose text changed and have no audio — synthesize exactly those and publish again). Use create_presentation instead to have the server narrate.
輸入參數slugaudiotitleassetshandlevoiceIddesignMdmadeWithcontextMdindexHtml必填visibilityspeechSpeed另有 2 個
get_presentation_status
Get presentation status
Fetch the build state and result URL for a presentationId.
輸入參數presentationId必填
list_presentations
List your presentations
List the authenticated user's presentations, newest first. One call returns at most `limit` of them. A non-null `nextCursor` in the response means more presentations remain: call again with `cursor` set to that value to get the page after this one, and keep going until `nextCursor` is null.
輸入參數limitcursorvisibility
get_presentation_analytics
Get presentation analytics
Watch analytics for one of your presentations: views, likes, completion rate, per-slide retention funnel, traffic sources, distinct signed-in/anonymous viewers, and organization email domains (personal providers filtered). Lets an agent read how its own published briefings performed.
輸入參數presentationId必填
get_presentation_context
Load a presentation into context
Load any shared Bisque presentation for reading: its metadata, the full per-slide narration transcript with timestamps, and the context.md file its author shipped for agents (extra background the slides summarize). Target it by watch URL (https://bisque.today/p/{handle}/{slug}) or by handle + slug — it does not have to be yours. Use this to read, summarize, cite, or answer questions about a presentation: ground your answers in the returned transcript and context, and cite slides as [slide N].
輸入參數urlslughandle
update_channel
Update channel
Update one of your channels. Set the description — the line a stranger reads in a search result or a link unfurl, at most 160 characters, empty to clear it and go back to naming the newest presentations. Set the avatar from an image URL, which is fetched, center-cropped square and resized. Pass either or both. Omit handle to use your default channel.
輸入參數handleimage_urldescription
create_artifact
Create an Artifact
Publish an HTML page or a Markdown document as a Bisque Artifact: a persistent, versioned page at a stable URL that people can open, comment on, and that you can update later with update_artifact. Pass the whole document as content. The call waits for the page to be ready and returns its URL. It is private to you unless you pass audience or share_with. A page that should remember what people do on it (a checklist, a poll, a sign-up sheet) declares capabilities ['state.read','state.write'] and, when some paths need different access, state.rules; it then reads and writes JSON documents through window.bisque.state. For a narrated presentation use create_presentation instead.
輸入參數icontypestatetitle必填listedcontent必填audienceicon_imageshare_withdescriptioncapabilities
list_artifacts
List your Artifacts
List Artifacts you own (scope owned, the default), ones shared with you (shared), or both (all), newest first. Each item carries its id, title, who can open it, and its URL.
輸入參數typelimitscopecursor
get_artifact
Get an Artifact
Read one Artifact: title, who can open it, the Version viewers see (published_version_id, null while a publication is still being prepared), and its URL.
輸入參數artifact_id必填
update_artifact
Update an Artifact
Change an Artifact you own or edit. Pass content to publish a new Version of the page at the same URL (the whole document, not a diff; earlier Versions stay in the history). Pass title, description, icon, or icon_image to change those. Any combination in one call. With content the call waits for the new Version to be live before returning. The new Version keeps the base Version's capabilities and state rules unless you pass capabilities or state.
輸入參數iconstatetitlecontenticon_imageartifact_id必填descriptioncapabilities
share_artifact
Share an Artifact
Set who can open an Artifact you own. audience picks the rule; share_with is the complete list of named people (it replaces the previous list; omit it to keep the current one). Going public deletes every comment thread, so a public change on an Artifact with threads is refused unless delete_threads is true. Returns the URL to send.
輸入參數listedaudience必填share_withartifact_id必填delete_threads
delete_artifact
Delete an Artifact
Delete an Artifact you own. Its URL stops working for everyone. Confirm with the user before calling this.
輸入參數artifact_id必填
list_artifact_threads
List Artifact comment threads
List the comment threads people left on one of your Artifacts, newest activity first. Pass activated_only: true to get only the threads where someone mentioned the agent, which are the ones you may reply to and resolve. Each thread carries its anchor (what it is pinned to), the version it was left on, a preview, and agent_activated.
輸入參數aftercursorstatusartifact_id必填activated_only
get_artifact_thread
Get an Artifact comment thread
Read one comment thread on an Artifact with every message, oldest first. Mentions in a body look like @[Name](mention:uid); a mention of the agent is @[Agent](mention:agent).
輸入參數thread_id必填artifact_id必填
create_artifact_thread
Start a comment thread on an Artifact
Leave a new comment thread on one of your Artifacts, as the agent. Without an anchor the thread is a general comment on the page. The thread is activated from the start, so you can reply to it and resolve it later. Mention a person with @[Name](mention:uid) using ids from the Artifact's mentionables.
輸入參數body必填anchorartifact_id必填
reply_to_artifact_thread
Reply in an Artifact comment thread
Post a reply in a comment thread as the agent. Allowed only on activated threads (agent_activated true): someone mentioned the agent, or the agent started the thread. People see it as "Agent · via <your name>".
輸入參數body必填thread_id必填artifact_id必填
resolve_artifact_thread
Resolve or reopen an Artifact comment thread
Mark a comment thread resolved (resolved: true) or reopen it (resolved: false), as the agent. Allowed only on activated threads. Resolve after you have addressed the comment, usually after republishing the Artifact; reply first so the person can see what changed.
輸入參數resolved必填thread_id必填artifact_id必填