Skip to main content
POST
/
api
/
sessions
Create a session
curl --request POST \
  --url https://api.example.com/api/sessions \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent": "<string>",
  "metadata": {},
  "userId": "<string>",
  "space": "production",
  "summary": "<string>"
}
'
{
  "id": "<string>",
  "agent": "<string>",
  "handle": "<string>",
  "createdAt": "2023-12-25",
  "updatedAt": "2023-12-25",
  "metadata": {},
  "user": {
    "id": "<string>",
    "externalId": "<string>",
    "createdAt": "2023-12-25",
    "updatedAt": "2023-12-25",
    "createdBy": "<string>",
    "space": "production",
    "token": "<string>"
  },
  "userId": "<string>",
  "space": "production",
  "summary": "<string>",
  "versions": [
    "<string>"
  ],
  "runs": [
    {
      "id": "<string>",
      "createdAt": "2023-12-25",
      "updatedAt": "2023-12-25",
      "finishedAt": "2023-12-25",
      "status": "<string>",
      "version": "<string>",
      "metadata": {},
      "sessionItems": [
        {
          "id": "<string>",
          "createdAt": "2023-12-25",
          "updatedAt": "2023-12-25",
          "runId": "<string>",
          "sessionId": "<string>",
          "content": "<unknown>"
        }
      ],
      "sessionId": "<string>",
      "versionId": "<string>",
      "failReason": "<unknown>"
    }
  ],
  "state": "<unknown>"
}

Body

application/json
​
agent
string
required
​
metadata
object
​
userId
string
​
space
enum<string>
Available options:
production,
playground,
shared-playground
​
summary
string | null

Response

Undescribed

​
id
string
required
​
agent
string
required
​
handle
string
required
​
createdAt
string<date>
required
​
updatedAt
string<date>
required
​
metadata
object
required
​
user
object
required
​
userId
string
required
​
space
enum<string>
required
Available options:
production,
playground,
shared-playground
​
summary
string | null
required
​
versions
string[]
required
​
runs
object[]
required
​
state
unknown