Create Chat
Chats
Create Chat
Start a new conversation for a chatbot and receive a chat ID.
POST
Create Chat
Create a new chat for one of your chatbots. The returned
chatId is required for sending messages and reading the conversation.
Authentication
This request requires your API key in thex-api-key header.
Request
string
required
ID of the chatbot the chat belongs to.
string
Optional ID identifying the end user. Use it to associate a chat with a known user in your system.
Response
string
required
ID of the created chat. Use it as the
chatId in later requests.string
required
ID of the chatbot the chat belongs to.
string
required
ID of the associated end user.
string
required
ID of the organization that owns the chat.
string
required
ISO 8601 timestamp of when the chat was created.
Examples
Success response
Error response
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.