SessionDock Developer Docs
Authoritative guides, generated Local API reference, and practical patterns for local automation, scripts, launchers, and AI agents running alongside SessionDock.
/api/v1/sessions/{id}/previewcurl -X GET 'http://127.0.0.1:18432/api/v1/sessions/session_123/preview' \
-H 'Authorization: Bearer <token>'| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
| id | path | string | Yes | Session identifier. | session_123 |
Preview metadata
application/json
{
"data": {
"id": "<string>",
"previewStatus": "<string>",
"preferredPreviewId": "<string>",
"previewUrl": "<string>",
"previewAudioUrl": "<string>",
"previewAudioMime": "<string>",
"previews": [
{
"id": "<string>",
"name": "<string>",
"path": "<string>",
"status": "<string>"
}
]
}
}{
"data": {
"id": "<string>",
"previewStatus": "<string>",
"preferredPreviewId": "<string>",
"previewUrl": "<string>",
"previewAudioUrl": "<string>",
"previewAudioMime": "<string>",
"previews": [
{
"id": "<string>",
"name": "<string>",
"path": "<string>",
"status": "<string>"
}
]
}
}Missing or invalid bearer token.
application/json
{
"error": {
"status": 0,
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"status": 401,
"code": "unauthorized",
"message": "Provide Authorization: Bearer <token>."
}
}No matching resource was found.
application/json
{
"error": {
"status": 0,
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"status": 404,
"code": "not_found",
"message": "session not found"
}
}