Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Ai chats

Create ai chat

Create a new AI chat thread and send the first message to the AI agent.

Required permissions:

  • ai_chat:create
post/ai_chats

Request body

current_company_idstring nullable

The unique identifier of the company to set as context for the AI chat (e.g., "biz_XXXXX").

message_source'manual' | 'suggestion' | 'link'

The source of an AI chat message

message_textstring required

The text content of the first message to send to the AI agent.

suggestion_typestring nullable

The type of suggestion prompt that was clicked, when message_source is 'suggestion'.

titlestring nullable

An optional display title for the AI chat thread (e.g., "Help with billing").

Response

A successful response

blended_token_usagestring required

The total number of tokens consumed across all messages in this conversation.

created_atstring date-time required

The datetime the ai chat was created.

idstring required

The unique identifier for the ai chat.

last_message_atstring date-time nullable required

The timestamp of the most recent message in this conversation. Null if no messages have been sent yet.

message_countinteger required

The total number of messages exchanged in this conversation.

notification_preference'all' | 'none' required

The notification preference for an AI chat

titlestring nullable required

A short descriptive title for this AI chat conversation. Null if no title has been set.

updated_atstring date-time required

The datetime the ai chat was last updated.

Example response

{
  "blended_token_usage": "123.45",
  "created_at": "2023-12-01T05:00:00.401Z",
  "id": "aich_xxxxxxxxxxxxx",
  "last_message_at": "2023-12-01T05:00:00.401Z",
  "message_count": 42,
  "title": "Weekly Revenue Analysis",
  "updated_at": "2023-12-01T05:00:00.401Z",
  "user": {
    "id": "user_xxxxxxxxxxxxx"
  }
}