Getting started
SessionDock’s developer documentation is split into two layers:
- conceptual guides for product behavior, integration strategy, and workflow design
- generated endpoint reference pages sourced from the Local API OpenAPI contract
The mental model
SessionDock is not a hosted service. The app exposes a Local API while the desktop app is running. That API is intended for tools such as:
- Raycast commands
- Stream Deck actions
- shell scripts
- local dashboards
- automation assistants
- internal production tooling
Warning
If you are looking for a public internet-facing API, this is not that product surface. The SessionDock Local API is intentionally localhost-only and designed for machine-local trust boundaries.
How to use these docs
Product and setup guidance
Read the product guides first when you need context:
Endpoint-level details
Open the API Reference when you need exact request and response details, schema shapes, status codes, and parameter documentation.
What the Local API can do today
- list, fetch, create, update, and delete sessions
- replace notes and tags on a session
- fetch preview metadata and waveform data
- replace waveform note markers
- open or focus a session in the desktop app
- trigger batch import jobs
Suggested first integration
If you want a quick success path, implement one of these first:
- a health check command that verifies your token
- a session search command that filters by title or tag
- a focused notes update command for the active project queue
SessionDock Pro context
Some automation scenarios depend on full-automation mode and, in practice, on features typically used by SessionDock Pro workflows such as batch import, mobile sync, and richer preview pipelines.