Skip to content

List Agent Sessions

GET
/agent/sessions

Sessions owned by, or shared with, the principal behind this key.

Authorizations

Parameters

Query Parameters

mode
Any of:
string

Filter to one session mode.

limit

Page size (max 200).

integer
default: 50 >= 1 <= 200

Page size (max 200).

offset

Rows to skip.

integer

Rows to skip.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

Sessions owned by, or shared with, the principal behind the key.

object
sessions
Array<object>

One agent chat session.

object
created_at
Any of:
string format: date-time
id
Any of:
string
is_pinned
Any of:
boolean
mode
Any of:
string
title
Any of:
string
updated_at
Any of:
string format: date-time
key
additional properties
any
total
integer
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string