Sessions

List sessions

Lists the sessions you own (called "notebooks" in the product UI), newest first. Sessions shared with you are not included; read one of those by id with GET /api/sessions/{id}. Each item has the same shape GET /api/sessions/{id} returns. Cursor-paginated (see the pagination convention): pass next_cursor back as cursor until it is null. Changing search, surface or origin starts a new listing, so drop the cursor when you do. An API key needs notebooks:read or notebooks:write.

get/api/v1/sessions

Request

  • Base URL: https://your-deployment.example.com
  • URL: https://your-deployment.example.com/api/v1/sessions
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Query parameters

limitinteger
cursorstring
searchstring

Case-insensitive substring match on the session name, its summary, or a tag name.

surfacestring

Lists only sessions of this product surface. When omitted, only sessions with no surface are listed.

origin'web' | 'api' | 'slack' | 'cli' | 'agent'

Lists only sessions created through this channel. web also matches sessions with no recorded origin.

Response

One page of sessions, newest first by id.

next_cursorstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.