sessions

Get session by workspace

Changed on

Returns session information for a specific workspace. Accepts workspace ID (UUID) or path. Use ?full=true for complete session data including messages. Supports conditional requests via If-None-Match header for efficient polling.

get/v1/sessions/workspace/{workspace}

Request

  • Base URL
    http://localhost:6369
  • URL
    http://localhost:6369/v1/sessions/workspace/{workspace}
  • Auth
    none declared

Path parameters

workspacestring required

Workspace ID (UUID) or directory path

Query parameters

fullboolean

Include full session data with messages and user prompts

Headers

If-None-Matchstring

ETag from previous request

Response

Basic session info when full=false

claude_session_uuidstring

Unique identifier for the Claude session

ended_atstring

When the session ended (if not active)

resumed_atstring

When the session was resumed (if applicable)

started_atstring

When the session was initially started

titlestring

Title of the session

Example response

{
  "claude_session_uuid": "abc123-def456-ghi789",
  "ended_at": "2024-01-15T18:30:00Z",
  "resumed_at": "2024-01-15T16:00:00Z",
  "started_at": "2024-01-15T14:30:00Z",
  "title": "Updating README.md"
}

Changes

  • 648598c377f9Revision changes
    • info

      added the new optional header request parameter If-None-Match

    • info

      added the non-success response with the status

  • 21270d5158bdRevision changes
    • warning

      deleted the header request parameter If-None-Match

    • info

      removed the non-success response with the status