Skip to main content
GET
Retrieve ai chat
Required permissions:
  • ai_chat:read

Yetkilendirmeler

Authorization
string
header
gerekli

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

ai_chat:read

Yol Parametreleri

id
string
gerekli

The unique identifier of the AI chat to retrieve.

Örnek:

"aich_xxxxxxxxxxxxx"

Yanıt

A successful response

An AI-powered chat conversation belonging to a user, with optional scheduled automation.

agent_identifier
enum<string>
gerekli

The AI agent that handles this chat. Set when the chat is created and fixed for its lifetime.

Mevcut seçenekler:
general,
support
blended_token_usage
string
gerekli

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

Örnek:

"123.45"

created_at
string<date-time>
gerekli

The datetime the ai chat was created.

Örnek:

"2023-12-01T05:00:00.401Z"

id
string
gerekli

The unique identifier for the ai chat.

Örnek:

"aich_xxxxxxxxxxxxx"

last_message_at
string<date-time> | null
gerekli

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

Örnek:

"2023-12-01T05:00:00.401Z"

message_count
integer
gerekli

The total number of messages exchanged in this conversation.

Örnek:

42

notification_preference
enum<string>
gerekli

The notification preference for this AI chat. all delivers AI chat notifications and badges, while none mutes them.

Mevcut seçenekler:
all,
none
title
string | null
gerekli

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

Örnek:

"Weekly Revenue Analysis"

updated_at
string<date-time>
gerekli

The datetime the ai chat was last updated.

Örnek:

"2023-12-01T05:00:00.401Z"

user
object
gerekli

The user who owns this AI chat conversation.