SessionDock Developer Docs

Make your creative workflow programmable.

Authoritative guides, generated Local API reference, and practical patterns for local automation, scripts, launchers, and AI agents running alongside SessionDock.

Check server health and token validity

Confirms that the Local API is running and the supplied bearer token is valid.

GET/api/v1/health

Confirms that the Local API is running and the supplied bearer token is valid.

curl -X GET 'http://127.0.0.1:18432/api/v1/health' \
  -H 'Authorization: Bearer <token>'

Responses

200

Health snapshot

application/json

Schema Shape

{
  "data": {
    "status": "ok",
    "configuredMode": "disabled",
    "effectiveMode": "disabled",
    "running": true,
    "port": 0,
    "baseUrl": "<string>",
    "docsUrl": "<string>",
    "requestCount": 0,
    "recentRequests": [
      {
        "method": "<string>",
        "path": "<string>",
        "statusCode": 0,
        "at": "2025-01-15T12:34:56Z"
      }
    ],
    "lastError": "<string>"
  }
}

Example

{
  "data": {
    "status": "ok",
    "running": true,
    "configuredMode": "read-only",
    "effectiveMode": "read-only",
    "port": 18432,
    "baseUrl": "http://127.0.0.1:18432/api/v1",
    "docsUrl": "http://127.0.0.1:18432/docs",
    "requestCount": 42,
    "recentRequests": []
  }
}

401

Missing or invalid bearer token.

application/json

Schema Shape

{
  "error": {
    "status": 0,
    "code": "<string>",
    "message": "<string>"
  }
}

Example

{
  "error": {
    "status": 401,
    "code": "unauthorized",
    "message": "Provide Authorization: Bearer <token>."
  }
}

PreviousAPI Reference NextList known tags with counts