POST
/
v1
/
{account_id}
/
{project_id}
/
chat
/
create
curl --request POST \
  --url https://api.us-1.platform.polyai.app/v1/{account_id}/{project_id}/chat/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "user_id": "<string>",
  "message": "<string>",
  "metadata": {}
}'
{
  "chat_id": "WEBCHAT_18bd8253-4019-4ba7-83b5-5ed602d5d84a"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
account_id
string
required

Account ID in the format ACCOUNT-xxxxxxxx. Uniquely identifies your PolyAI account.

​
project_id
string
required

Project ID in the format PROJECT-xxxxxxxx. Combined with the account_id, this uniquely identifies a PolyAI project.

Body

application/json
​
user_id
string

Unique identifier for the user initiating the chat session. Useful for associating the chat with a specific user in your system.

​
message
string

The initial message content sent to start the chat session.

​
metadata
object

Optional metadata to provide additional context for the chat session. This can include custom attributes or other relevant information.

Response

201
application/json
Chat session created successfully.
​
chat_id
string

A unique identifier for the created chat session. Used in subsequent operations.

OverviewRespond to a chat