Skip to main content
POST
/
v2
/
workspaces
/
{workspace_id}
/
sessions
Get Or Create Session
curl --request POST \
  --url http://localhost:8000/v2/workspaces/{workspace_id}/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "metadata": {},
  "peers": {},
  "configuration": {
    "deriver": {
      "enabled": true,
      "custom_instructions": "<string>"
    },
    "peer_card": {
      "use": true,
      "create": true
    },
    "summary": {
      "enabled": true,
      "messages_per_short_summary": 11,
      "messages_per_long_summary": 21
    },
    "dream": {
      "enabled": true
    }
  }
}
'
{
  "id": "<string>",
  "is_active": true,
  "workspace_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "configuration": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workspace_id
string
required

ID of the workspace

Body

application/json

Session creation parameters

​
id
string
required
Required string length: 1 - 100
​
metadata
Metadata · object
​
peers
Peers · object
​
configuration
SessionConfiguration · object

The set of options that can be in a session DB-level configuration dictionary.

All fields are optional. Session-level configuration overrides workspace-level configuration, which overrides global configuration.

Response

Successful Response

​
id
string
required
​
is_active
boolean
required
​
workspace_id
string
required
​
created_at
string<date-time>
required
​
metadata
Metadata · object
​
configuration
Configuration · object