Skip to main content
POST
/
api
/
v1
/
chat
/
sessions
{
  "id": "<string>",
  "agent": {},
  "metadata": {},
  "state": "IDLE",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
metadata
object
required

Metadata for the chat session (max 4096 characters)

​
agentId
string

The ID of the agent for this chat session

Response

The chat session has been created successfully.

​
id
string
required

The unique identifier for the chat session

​
agent
object
required

The details of the current agent

​
metadata
object
required

Metadata for the chat session

​
state
enum<string>
required

The current state of the chat session

Available options:
IDLE,
ACTIVE,
CLOSED
​
createdAt
string<date-time>
required

The creation timestamp of the chat session