POST
/
chat
/
new
Create a new chat
curl --request POST \
  --url https://api.qtzl.ai/chat/new \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "participants": [
    {
      "id": "<string>",
      "locale": "<string>",
      "name": "<string>"
    }
  ],
  "external_id": "<string>"
}'
{
  "result": "ok",
  "message": "A chat has been created",
  "quetzal_chat_id": 123,
  "external_id": "<string>",
  "participants": [
    {
      "id": "<string>",
      "locale": "<string>",
      "role": "<string>"
    }
  ]
}
Define a new chat by providing a list of participants. Every participant must have a locale, and then optionally a name and a role. All messages that are then added to a chat will be translated for every other participant.

Authorizations

​
api-key
string
header
required

API key authentication. You can obtain your API key by registering on your project dashboard.

Body

application/json
​
participants
object[]
required

List of participants in the chat

Minimum length: 1
​
external_id
string

External identifier for the chat

Response

Chat successfully created

​
result
string
Example:

"ok"

​
message
string
Example:

"A chat has been created"

​
quetzal_chat_id
integer

The internal chat ID

​
external_id
string

External identifier for the chat (if provided)

​
participants
object[]