POST
/
api
/
ai
/
session
/
create

Authorizations

Authorization
string
headerrequired

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

Body

application/json
is_multidoc
boolean
required

Whether this is a multi-doc chat session. A multi-doc session can have only one (or zero) Documents in it, but a single-doc session cannot have more than one Document

organization_id
integer
required

The Organization in which to create the session

user_id
integer
required

The user's unique ID

document_ids
integer[]

The IDs of the documents to include in this chat Session

meta
object

Session 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

200 - application/json
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
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: sharedrequired

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