SessionDock developer docs
SessionDock ships with a localhost-only automation API, generated API reference, and a growing set of integration patterns for producers, engineers, launchers, dashboards, control surfaces, and AI tools.
Start here
- Get started: Understand the docs structure, how the Local API is meant to be used, and where to begin.
- Install and enable: Turn on the Local API, locate your token, and verify your setup from the command line.
- Authentication: Learn the three Local API modes, bearer token rules, and write gating behavior.
- API reference: Browse every endpoint from the generated OpenAPI contract.
What this system covers
- Human-authored guides live alongside the website content tree.
- Endpoint reference pages are generated automatically from the checked-in OpenAPI 3.1 contract.
- The checked-in YAML is designed to stay aligned with SessionDock’s actual backend API over time.
- Product-specific concepts like preview variants, waveform notes, write modes, and SessionDock Pro are documented in one place.
Recommended reading order
- Start with Getting Started.
- Follow Installation and Authentication.
- Read Local API Overview before using the generated API Reference.
- Use Automation Examples when you want concrete workflows to copy.
Local-first by design
SessionDock’s Local API only binds to
127.0.0.1. It is intended for trusted tools running on the same machine as the desktop app.
What makes SessionDock different
Unlike a generic cloud REST API, SessionDock’s local automation surface is built around studio workflows:
- session metadata and status updates
- preview and waveform access
- import automation for large project libraries
- launch and focus actions for the desktop app
- safe read-only access for assistants and dashboards
The rest of the docs keep that perspective: practical, desktop-first, and optimized for maintainability.