PLplastic-labs
sessions

Get Or Create Session

Changed on

Get a Session by ID or create a new Session with the given ID.

If Session ID is provided as a parameter, it verifies the Session is in the Workspace. Otherwise, it uses the session_id from the JWT for verification.

post/v3/workspaces/{workspace_id}/sessions

Request

  • Base URL
    https://api.honcho.dev
  • Auth
    HTTP bearer

Path parameters

workspace_idstring required

Request body

idstring required
metadataobject nullable
peersobject nullable
scopesstring[] nullable

Optional list of (unprefixed) scope names to add this session to. Each scope is created if it does not exist yet. If the session already has messages, its existing documents are backfilled into the scope asynchronously.

Response

Successful Response

idstring required
uidstring required

Immutable identifier Honcho assigns to this session. id is the name the client chose; uid is generated by the server.

is_activeboolean required
workspace_idstring required
metadataobject
configurationobject
created_atstring date-time required
scopesstring[] nullable

Names of the scopes this session is an active member of. Only returned by the session list when include_scopes is true.

Changes