Skip to main content
POST
/
api
/
ai
/
session
/
{ai_session_id}
/
update
Update the visibility or metadata of an AI chat session
curl --request POST \
  --url https://cite.petal.org/api/ai/session/{ai_session_id}/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_ids": [
    123
  ],
  "meta": {},
  "visibility": "shared"
}
'
{
  "created_at": "<string>",
  "id": 123,
  "is_multidoc": true,
  "meta": {},
  "organization_id": 123,
  "user_id": 123,
  "visibility": "shared",
  "document_ids": [
    123
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
ai_session_id
integer<int32>
required

The unique ID of the AI Session

Body

application/json
​
document_ids
integer[]

List of Document IDs in this Session

​
meta
Meta · object

Metadata, for internal use

​
visibility
enum<string>
default:shared

Whether this session can only be seen by its creator, or by the whole Workspace

Available options:
shared,
private

Response

OK

​
created_at
string
required

Creation time, by UTC

​
id
integer
required

Unique ID of this Session

​
is_multidoc
boolean
required

Whether this is a multi-doc chat session

​
meta
Meta · object
required

Session metadata, for internal use

​
organization_id
integer
required

Unique ID of Organization

​
user_id
integer
required

Unique ID of user

​
visibility
enum<string>
default:shared
required

Whether this session can only be seen by its creator, or by the whole Workspace

Available options:
shared,
private
​
document_ids
integer[]

List of Document IDs in this Session