API Description
Create a conversation with an agent.
Basic Information
| Request Method |
Request URL |
| POST |
https://api.helpbots.ai/api/chats/conversation |
Request Parameters
Header
| Parameter Name |
Value |
Description |
| x-api-key |
$apikey |
Access token used to verify client identity. You can generate the token in the dashboard. For details, see Get API Key. |
| Content-Type |
application/json |
Specifies the format of the request body. |
Body Parameters
| Parameter Name |
Type |
Required |
Description |
| id |
int |
Yes |
Agent ID associated with the created conversation. |
| user_id |
string |
Yes |
User ID associated with the created conversation. |
Example
Request Example
curl --location --request POST 'https://api.helpbots.ai/api/chats/conversation' \
--header 'x-api-key: yourapikey' \
--header 'Content-Type: application/json' \
--data-raw '{
"id":18,
"user_id":11
}'
Response Example
{
"data": {
"conversation_id": "1gl80omnaonbvgo0ds5apzk9" # Conversation ID
},
"msg": "Success",
"code": 200
}