Skip to content
SynthBoard
Back to /api

API reference

The full REST API, every endpoint.

Live OpenAPI 3.1 reference — try requests inline, copy the curl, or generate client code in any language.

Generate API keyOpenAPI spec

Every endpoint, at a glance

46 endpoints under /api/v1, grouped the way the reference below groups them. Every path takes a Bearer API key; the full request and response schemas are in the interactive reference.

Meta

  • get/healthUnauthenticated health probe

Sessions

  • get/sessionsList sessions
  • post/sessionsStart a session (plan_id OR explicit setup; boardroom or consult)
  • post/sessions/planPropose a session setup without starting
  • get/sessions/{id}Get session state + latest task
  • patch/sessions/{id}Rename / retag a session
  • delete/sessions/{id}Delete a draft session (only sessions with status='draft' are deletable)
  • post/sessions/{id}/continueTrigger a follow-up round (legacy-engine sessions)
  • post/sessions/{id}/reconveneChain a new board round on a completed board
  • post/sessions/{id}/messagesSend one Consult turn
  • post/sessions/{id}/cancelCancel in-flight task
  • post/sessions/{id}/outcomesGenerate deliverable (action_plan / report / decision_memo / bullets)
  • post/sessions/{id}/exportExport session as markdown / json / text
  • post/sessions/{id}/archiveArchive or unarchive a session
  • post/sessions/{id}/forkDuplicate a session as a draft with altered context
  • post/sessions/{id}/updateMid-session updates (seats and settings)
  • get/sessions/{id}/live-summaryLive summary snapshot
  • get/sessions/{id}/cross-roundCross-round position trends
  • post/sessions/{id}/assistantAsk the Session Assistant
  • post/sessions/{id}/bookmarksBookmark a moment or pin a thread
  • post/sessions/{id}/decisionsCapture a formal decision record

Synths

  • post/synths/chat1-on-1 chat with a synth
  • get/synthsList synths (core + public + your own custom)
  • post/synthsCreate a custom synth
  • get/synths/{id}Get a synth (core/public/owned)
  • patch/synths/{id}Update one of your custom synths
  • delete/synths/{id}Delete one of your custom synths
  • patch/synths/{id}/preferencesSet your per-user preferences for a core synth
  • delete/synths/{id}/preferencesReset core-synth preferences to SynthBoard defaults
  • get/synths/{id}/knowledgeList a custom synth's knowledge files
  • post/synths/{id}/knowledgeAdd knowledge to a custom synth (URL or text)
  • delete/synths/{id}/knowledge/{fileId}Remove a knowledge file from a custom synth
  • post/sessions/{id}/promote-to-synthPromote session documents into a custom synth's permanent knowledge

Catalog

  • get/catalog/searchSearch synths / modes / templates / strategies / models

Shares

  • get/sharesList shares for a session
  • post/sharesCreate a share link
  • delete/shares/{id}Revoke a share link
  • post/shares/verify-passwordVerify a password-protected share

Actions

  • post/actions/executeExecute a Recommended Action via a connected integration
  • post/actions/undoUndo a previously executed action
  • get/integrationsList connected integrations

Webhooks

  • get/webhooksList webhook subscriptions
  • post/webhooksCreate a webhook subscription
  • patch/webhooks/{id}Update / enable / disable a subscription
  • delete/webhooks/{id}Delete a subscription
  • get/webhooks/{id}/deliveriesRecent delivery attempts for a subscription
Loading the API reference…