Sign in
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

agent_identifier'general' | 'support'

The AI agent that handles an AI chat.

current_account_idstring nullable

The unique identifier of the account 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

agent_identifier'general' | 'support' required

The AI agent that handles an AI chat.

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"
  }
}

Changes

Changed in 2 of the 74 revisions of this API.13

  • 35b1eba5f2032See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the required property to the response with the status

      response-required-property-added

  • 697924df40d111See the full diff
    • ●

      removed the request property

      request-property-removed

    • ○

      added the new optional request property

      new-optional-request-property

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.