Sessions

Clone a session

Clones a session (called a "notebook" in the product UI), including its messages and attachments. Omit targetSurface to inherit the source workspace, send null for the main notebook list, or send a surface id for another workspace. An API key needs notebooks:write.

post/api/v1/sessions/{id}/clone

Request

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

Path parameters

idstring required

Request body

targetSurfacestring nullable

Example request

{}

Response

The cloned 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.