Skip to content

Pin Agent Session

POST
/agent/sessions/{session_id}/pin

Pin or unpin a session. Owner only.

Authorizations

Parameters

Path Parameters

session_id
required

Session id.

string

Session id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
is_pinned
required

True to pin, false to unpin.

boolean

Responses

200

Successful Response

object
data
required

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
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