Sessions

Get a session

Reads a session you own or that was shared with you (called a "notebook" in the product UI): its name, attached knowledge files, tags, and retrieval settings. Use it to confirm what a PUT on the same path stored. A session not visible to you, or one that was deleted, is 404. An API key needs notebooks:read or notebooks:write.

get/api/sessions/{id}

Request

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

Path parameters

idstring required

Response

The session.

idstring required
_idstring
namestring required
userIdstring required
knowledgeIdsstring[]
artifactIdsstring[]
forceKnowledgeRetrievalboolean
retrievalTagsstring[]
lakeScopeExplicitboolean

True when retrievalTags is a deliberate choice, so an empty list means "no lake" rather than "any".

includeLibraryFilesboolean

Whether the session grounds on your own library alongside its lakes. Absent when never set.

lastUsedModelstring nullable
firstCreatedstring date-time required
lastUpdatedstring date-time required

Changes

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