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

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de ruta

id
string
requerido

The unique identifier of the AI chat to retrieve.

Ejemplo:

"aich_xxxxxxxxxxxxx"

Respuesta

A successful response

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

agent_identifier
enum<string>
requerido

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

Opciones disponibles:
general,
support
blended_token_usage
string
requerido

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

Ejemplo:

"123.45"

created_at
string<date-time>
requerido

The datetime the ai chat was created.

Ejemplo:

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

id
string
requerido

The unique identifier for the ai chat.

Ejemplo:

"aich_xxxxxxxxxxxxx"

last_message_at
string<date-time> | null
requerido

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

Ejemplo:

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

message_count
integer
requerido

The total number of messages exchanged in this conversation.

Ejemplo:

42

notification_preference
enum<string>
requerido

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

Opciones disponibles:
all,
none
title
string | null
requerido

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

Ejemplo:

"Weekly Revenue Analysis"

updated_at
string<date-time>
requerido

The datetime the ai chat was last updated.

Ejemplo:

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

user
object
requerido

The user who owns this AI chat conversation.