Skip to main content
POST
/
v1
/
session
/
client
Create a new session
curl --request POST \
  --url https://api.agentreach.ai/v1/session/client \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentId": "<string>",
  "channel": {
    "type": "web-ui",
    "slackUserId": "<string>",
    "email": "<string>"
  },
  "message": "<string>",
  "userId": "<string>"
}
'
{
  "id": "<string>",
  "sessionId": "<string>",
  "message": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "fromAgent": true
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Details of the session to create.

​
agentId
string
required

Unique identifier for the agent.

​
channel
object
required
​
message
string
required

Initial message to start the session.

​
userId
string

Unique identifier for the user (optional).

Response

Session created successfully.

​
id
string
required

Unique identifier for the message.

​
sessionId
string
required

Unique identifier for the session.

​
message
string
required

Content of the message.

​
createdAt
string<date-time>
required

Timestamp when the message was created.

​
fromAgent
boolean
required

Indicates if the message is from the agent (true) or the user (false).