listSessions

GET

/api/v1/agents/{agentId}/sessions

listSessions

curl --request GET \
  --url '<base-url>/api/v1/agents/<agentId>/sessions' \
  --cookie 'agenthold_session=<agenthold_session>'

const url = '<base-url>/api/v1/agents/<agentId>/sessions';
const options = {
  method: 'GET',
  headers: {cookie: 'agenthold_session=<agenthold_session>'}
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "<base-url>/api/v1/agents/<agentId>/sessions"

headers = {"cookie": "agenthold_session=<agenthold_session>"}

response = requests.get(url, headers=headers)

print(response.text)

Response example

[
  {
    "id": "string",
    "agentId": "string",
    "origin": {
      "agentId": "string",
      "agentName": "string",
      "sessionId": "string"
    },
    "title": "string",
    "running": true,
    "createdBy": {
      "id": "string",
      "email": "string",
      "name": "string",
      "avatarUrl": "string"
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
]

{
  "error": "string"
}

Authorization

session
optional
API key in cookie

token
optional
HTTP Bearer
Authorization: Bearer <token>

Path parameters

agentId
string
required

Returns

200

Sessions, most recently active first.

JSON

id
string
required
agentId
string
required
title
string
required
running
boolean
required
createdBy
object
required
- id
  string
  required
- email
  string
  required
- name
  string
  required
- avatarUrl
  string
  required
}
createdAt
string
required
format: date-time
updatedAt
string
required
format: date-time
origin
optional
object
Set when another agent started the session (send_message or ask).
- agentId
  string
  required
- agentName
  string
  required
- sessionId
  string
  required
  The other agent's session that sent the messages.
}

404

Error.

JSON

error
string
required