Create ai chat
Create a new AI chat thread and send the first message to the AI agent.
Required permissions:
ai_chat:create
Authorizations
A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************
Body
Parameters for CreateAiChat
The text content of the first message to send to the AI agent.
The unique identifier of the company to set as context for the AI chat (e.g., "biz_XXXXX").
A list of previously uploaded file attachments to include with the first message.
The source of the message.
manual, suggestion, link The type of suggestion prompt that was clicked, when message_source is 'suggestion'.
An optional display title for the AI chat thread (e.g., "Help with billing").
Response
A successful response
An AI-powered chat conversation belonging to a user, with optional scheduled automation.
The total number of tokens consumed across all messages in this conversation.
"123.45"
The datetime the ai chat was created.
"2023-12-01T05:00:00.401Z"
The unique identifier for the ai chat.
"aich_xxxxxxxxxxxxx"
The timestamp of the most recent message in this conversation. Null if no messages have been sent yet.
"2023-12-01T05:00:00.401Z"
The total number of messages exchanged in this conversation.
42
The notification preference for this AI chat. all delivers AI chat notifications and badges, while none mutes them.
all, none A short descriptive title for this AI chat conversation. Null if no title has been set.
"Weekly Revenue Analysis"
The datetime the ai chat was last updated.
"2023-12-01T05:00:00.401Z"
The user who owns this AI chat conversation.

