Getting Started
Embed Methods
Website Builders
E-commerce
API Reference
- Introduction
- Pagination and Filtering
- GETGet Org by Domain Hostname
- GETGet Chat
- DELDelete Chat
- GETGet Chat Messages
- POSTCreate Chat Message
- GETGet Chat Message
- DELDelete Chat Message
- POSTCreate Chat Note
- GETGet Chat Files
- GETGet conversation summaries
- DELClear conversation summaries
- DELDelete a conversation summary
- GETGet Org Chats
- GETGet Domains
- POSTCreate Domain
- GETGet a Domain
- DELDelete Domain
- POSTGet Domain Status
- POSTVerify Domain
- GETGet Vector Index
- GETGet Contents
- POSTCreate Content
- GETGet Content
- DELDelete Content
- PATCHUpdate Content
- PATCHPatch orgs knowledgecontents url
- POSTCreate Child Content
- POSTReindex Content
- GETGet Content Chunks
- GETGet Content Chunk
- GETGet Assistants
- POSTCreate Assistant
- GETGet Assistant
- DELDelete Assistant
- PATCHUpdate Assistant
- POSTRotate Assistant Secret Key
- GETGet Assistant Integrations
- POSTCreate Assistant Integration
- GETGet Assistant Integration
- DELDelete Assistant Integration
- PATCHUpdate Assistant Integration
- GETGet Assistant Actions
- POSTCreate Assistant Action
- GETGet Assistant Action
- DELDelete Assistant Action
- PATCHUpdate Assistant Action
- GETSearch Available Contents
- GETGet Contents
- POSTLink Knowledge Content to Assistant
- DELUnlink Knowledge Content from Assistant
- GETGet Org Variables
- POSTCreate Org Variable
- PATCHUpdate Org Variables
- DELDelete Org Variable
- PATCHRename Org Variable
- GETList Files
- POSTCreate File
- GETGet File
- DELDelete File
- GETGet Contacts
- POSTMerge Contacts
- GETGet a Contact
- DELDelete a contact
- PATCHUpdate a Contact
- DELDelete a contact channel
- PATCHUpdate a contact channel (only for custom channels)
- GETGet Contact Files
- GETList contact notes
- POSTCreate a contact note
- GETGet a contact note
- DELDelete a contact note
- PATCHUpdate a contact note
- GETGet contact memories
- DELClear all contact memories
- DELDelete a specific contact memory
- GET
Get Org Chats
Get a list of chats for a specific org.
[
{
"id": "<string>",
"title": "<string>",
"model": "<string>",
"members": [
{
"id": "<string>",
"role": "ADMIN",
"user": {
"id": "<string>",
"name": "<string>",
"avatar": "<string>"
},
"session": {
"id": "<string>"
},
"contact_channel": {
"id": "<string>",
"channel_type": "internal",
"channel_id": "<string>",
"channel_name": "<string>",
"channel_display_name": "<string>",
"channel_avatar": "<string>",
"country": "<string>",
"agent": "<string>",
"ip": "<string>",
"language": "<string>",
"contact": {
"id": "<string>",
"name": "<string>",
"blocked": true
},
"link": "<string>"
}
}
],
"temporary": true,
"visibility": "PRIVATE",
"pinned": true,
"status": "RUNNING",
"shared_url": "<string>",
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"tools": [
{
"name": "<string>",
"display_name": "<string>",
"action_name": "<string>",
"description": "<string>",
"icon": "StepFormIcon",
"icon_url": "<string>",
"connection_id": "<string>",
"parameters": {},
"enabled_by_default": true,
"callback": "<string>"
}
],
"features": {
"web_search": {},
"reasoning": {
"effort": "low"
}
},
"org_id": "<string>",
"state": {
"id": "<string>",
"state": "OPEN",
"integration_id": "internal",
"assistant_id": "<string>",
"assistant_integration_id": "<string>",
"conversation_id": "<string>",
"ai_enabled": true,
"admin_unseen_count": 123,
"user_unseen_count": 123,
"assistant_integration": {
"id": "<string>",
"enabled": true
},
"assigned_user": {
"id": "<string>",
"name": "<string>",
"email": "[email protected]",
"avatar": "<string>",
"seen_at": "2023-12-25"
},
"assigned_at": "2023-12-25",
"assistant_config": {
"language": "auto",
"model": "<string>",
"stt": {
"model": "<string>"
},
"tts": {
"model": "<string>",
"voice_id": "<string>"
},
"conversation": {
"thread_mode": "new",
"enable_memories": true,
"enable_end_conversation_tool": true,
"enable_transfer_to_human_tool": true,
"welcome_banner": "<string>",
"suggested_messages": [
"<string>"
],
"auto_intro_message": "<string>",
"enable_private_chats": true
},
"knowledge_scope": "all",
"instructions": "<string>"
}
},
"link": "<string>",
"last_message": {
"id": "<string>",
"role": "user",
"model": "<string>",
"status": "RUNNING",
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"messages": [
{
"role": "system",
"parts": [
{
"type": "text",
"text": "<string>",
"audio": {
"id": "<string>",
"file_path": "<string>",
"file_filename": "document.pdf",
"file_size": 1024,
"file_mimetype": "application/pdf",
"file_url": "<string>",
"created_at": "2023-12-25"
},
"start_timestamp": 123,
"end_timestamp": 123
}
]
}
],
"tools": [
{
"name": "<string>",
"display_name": "<string>",
"action_name": "<string>",
"description": "<string>",
"icon": "StepFormIcon",
"icon_url": "<string>",
"connection_id": "<string>",
"parameters": {},
"enabled_by_default": true,
"callback": "<string>"
}
],
"features": {
"web_search": {},
"reasoning": {
"effort": "low"
}
},
"member": {
"id": "<string>",
"role": "ADMIN",
"user": {
"id": "<string>",
"name": "<string>",
"avatar": "<string>"
},
"session": {
"id": "<string>"
},
"contact_channel": {
"id": "<string>",
"channel_type": "internal",
"channel_id": "<string>",
"channel_name": "<string>",
"channel_display_name": "<string>",
"channel_avatar": "<string>",
"country": "<string>",
"agent": "<string>",
"ip": "<string>",
"language": "<string>",
"contact": {
"id": "<string>",
"name": "<string>",
"blocked": true
},
"link": "<string>"
}
},
"error": "<string>",
"usage": {
"input_tokens": 123,
"output_tokens": 123,
"total_tokens": 123,
"reasoning_tokens": 123,
"cached_input_tokens": 123
}
}
}
]Path Parameters
The ID of the org
Query Parameters
Search term to filter chats
256ID of the connection integration
internal, custom, whatsapp_bot, instagram_dm, slack_bot, telegram_bot, gmail, google_calendar ALL, RUNNING, COMPLETED, FAILED, CANCELED ALL, OPEN, SNOOZED, CLOSED ALL, ENABLED, DISABLED ALL, UNREAD, UNRESOLVED, RESOLVED, ASSIGNED_TO_ME, UNASSIGNED Page number
Number of items to take
Next page token (Only used on special endpoints)
Response
The title of the chat
The model used for the chat
The members of the chat
Show child attributes
Show child attributes
The role of the member in the chat
ADMIN, MEMBER Schema for the public contact channel
Show child attributes
Show child attributes
ID of the connection integration
internal, custom, whatsapp_bot, instagram_dm, slack_bot, telegram_bot, gmail, google_calendar The unique identifier for the contact channel, e.g Phone Number
The display name for the contact channel, e.g X Handle
The display name for the contact channel, e.g X Display Name
The avatar for the contact channel, e.g X Avatar URL
The country code associated with the contact channel, e.g US for United States
The user agent associated with the contact channel
The IP address associated with the contact channel
The language code associated with the contact channel, e.g en for English
A link to the contact channel, e.g a link to the social media profile
Whether the chat is temporary and would be deleted after 24 hours of last activity
The visibility of the chat
PRIVATE, PUBLIC_READ, PUBLIC_WRITE Whether the chat is pinned in the user interface
The status of the chat
RUNNING, COMPLETED, FAILED, CANCELED The shared URL of the chat, if it is shared
The tools available in the chat
Show child attributes
Show child attributes
Name of the tool to called, can be a step key or custom tool
256Display name of the tool, can be used in UI
256The original name of the action this tool is based on, used for connection-based tools
256Description of the tool
2048The name of the icon to use in the UI The name of the icon to use in the UI
StepFormIcon, StepAiIcon, StepNoteIcon, StepBranchIcon, StepCodeIcon, ConnectionIcon, ConnectionSchedulerIcon, ConnectionFilesIcon, ConnectionHttpIcon, ConnectionWorkflowIcon, ConnectionMcpIcon, CustomIntegrationIcon, ToolThinkIcon, ToolWebSearchIcon, ToolWebScrapingIcon, ToolGenerateImageIcon, ToolCalculatorIcon, ToolGenerateFileIcon, ToolGeneratePdfIcon, ToolDeepResearchIcon, ToolSearchKbIcon, ToolShowOptionsIcon, ToolRequestLocationIcon, ToolManageMemoryIcon, ClockFadingIcon, CalendarIcon, CloudIcon, GlobeAltIcon, LockClosedIcon, FileSpreadsheetIcon, DatabaseIcon, TableIcon, TableRowIcon, TableRowAddIcon, TableRowEditIcon, TableRowDeleteIcon, TableRowsIcon, PageIcon, UserIcon, EmailIcon, PhoneIcon, CurrencyIcon, FunctionIcon, TableCellsIcon, DocumentTextIcon, QueueListIcon, TagIcon, ModelAutoIcon, ModelOpenAIIcon, ModelAnthropicIcon, ModelGoogleIcon, ModelXAIIcon, ModelPerplexityIcon, ModelGroqIcon, ModelAzureIcon, ModelElevenLabsIcon, ModelDeepgramIcon 125URL of the icon to use in the UI
Connection ID for the tool, used for connection-based tools
Parameters for the tool call using an input schema definition
Show child attributes
Show child attributes
The file type allows users to upload files
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
Show child attributes
Show child attributes
The type of the field
file The name of the field
1024The description of the field
10240Indicates whether the field is optional
Indicates whether the field can contain multiple values
The placeholder of the field
512Display options for the file field
Show child attributes
Show child attributes
Controls how the label and field are arranged (inline or stacked)
inline, stacked Controls how the field container behaves in terms of width and positioning
grid, full, center The render type of the file field
button, dropzone The order of the field relative to other fields in the form
x >= 0The link to the documentation for the field
Indicates the mode of the selector, auto will allow AI to determine the value, manual will allow the user to manually input a value
all, auto, manual Integration configuration, when specified it makes this field configurable at the integration level
Indicates whether the field is hidden from the UI
Allowed mime types for the file field (e.g. image/*, application/pdf)
Whether the file is private or public, private files URLs are signed with a token and can be accessed temporarily
PUBLIC, PRIVATE "PRIVATE"
Whether the tool is enabled by default in the workflow
Enabled features for the model
Show child attributes
Show child attributes
Schema for the chat state
Show child attributes
Show child attributes
The state status of the chat
OPEN, SNOOZED, CLOSED ID of the connection integration
internal, custom, whatsapp_bot, instagram_dm, slack_bot, telegram_bot, gmail, google_calendar The ID of the assistant used in the chat
The ID of the assistant integration used in the chat
The ID of the conversation associated with the chat
Whether AI is enabled for the chat
The number of unseen messages in the chat
The number of unseen messages in the chat
Schema for the configuration of an assistant
Show child attributes
Show child attributes
List of supported languages for the model in ISO 639-1 format or "auto"
auto, en, es The model to use for the assistant
1 - 128Configuration options for the conversation thread of the assistant
Show child attributes
Show child attributes
The thread mode of the assistant, either "new" for new threads or "continue" for continuing existing threads
new, continue Whether to enable the "Manage Memories" tool for the assistant
Whether to enable the "End Conversation" tool for the assistant
Whether to enable the "Transfer to Human" tool for the assistant
Static greeting text displayed in the UI when users start a new conversation
256Suggested messages displayed to users when they start a new conversation
564First message automatically sent by the assistant only when a conversation begins via API call
256Whether to enable private chats that do not appear in the inbox
The knowledge scope of the assistant
all, restricted 10240The link to the chat in the integration
The chat message schema
Show child attributes
Show child attributes
The role of the message
user, assistant, system, tool, event, note The model used for the message
The chat status
RUNNING, COMPLETED, FAILED, CANCELED The message content
System message
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Show child attributes
Show child attributes
system Show child attributes
Show child attributes
text Detailed information about a file
Show child attributes
Show child attributes
Unique identifier for the file
Path to the file in the storage system
2048Name of the file
255"document.pdf"
Size of the file in bytes
1024
MIME type of the file
255"application/pdf"
URL to access the file
2048Timestamp when the file was created
Timestamp when the message part started processing, in milliseconds
Timestamp when the message part finished processing, in milliseconds
The tools used in the message
10Show child attributes
Show child attributes
Name of the tool to called, can be a step key or custom tool
256Display name of the tool, can be used in UI
256The original name of the action this tool is based on, used for connection-based tools
256Description of the tool
2048The name of the icon to use in the UI The name of the icon to use in the UI
StepFormIcon, StepAiIcon, StepNoteIcon, StepBranchIcon, StepCodeIcon, ConnectionIcon, ConnectionSchedulerIcon, ConnectionFilesIcon, ConnectionHttpIcon, ConnectionWorkflowIcon, ConnectionMcpIcon, CustomIntegrationIcon, ToolThinkIcon, ToolWebSearchIcon, ToolWebScrapingIcon, ToolGenerateImageIcon, ToolCalculatorIcon, ToolGenerateFileIcon, ToolGeneratePdfIcon, ToolDeepResearchIcon, ToolSearchKbIcon, ToolShowOptionsIcon, ToolRequestLocationIcon, ToolManageMemoryIcon, ClockFadingIcon, CalendarIcon, CloudIcon, GlobeAltIcon, LockClosedIcon, FileSpreadsheetIcon, DatabaseIcon, TableIcon, TableRowIcon, TableRowAddIcon, TableRowEditIcon, TableRowDeleteIcon, TableRowsIcon, PageIcon, UserIcon, EmailIcon, PhoneIcon, CurrencyIcon, FunctionIcon, TableCellsIcon, DocumentTextIcon, QueueListIcon, TagIcon, ModelAutoIcon, ModelOpenAIIcon, ModelAnthropicIcon, ModelGoogleIcon, ModelXAIIcon, ModelPerplexityIcon, ModelGroqIcon, ModelAzureIcon, ModelElevenLabsIcon, ModelDeepgramIcon 125URL of the icon to use in the UI
Connection ID for the tool, used for connection-based tools
Parameters for the tool call using an input schema definition
Show child attributes
Show child attributes
The file type allows users to upload files
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
Show child attributes
Show child attributes
The type of the field
file The name of the field
1024The description of the field
10240Indicates whether the field is optional
Indicates whether the field can contain multiple values
The placeholder of the field
512Display options for the file field
Show child attributes
Show child attributes
Controls how the label and field are arranged (inline or stacked)
inline, stacked Controls how the field container behaves in terms of width and positioning
grid, full, center The render type of the file field
button, dropzone The order of the field relative to other fields in the form
x >= 0The link to the documentation for the field
Indicates the mode of the selector, auto will allow AI to determine the value, manual will allow the user to manually input a value
all, auto, manual Integration configuration, when specified it makes this field configurable at the integration level
Indicates whether the field is hidden from the UI
Allowed mime types for the file field (e.g. image/*, application/pdf)
Whether the file is private or public, private files URLs are signed with a token and can be accessed temporarily
PUBLIC, PRIVATE "PRIVATE"
Whether the tool is enabled by default in the workflow
Enabled features for the model
Show child attributes
Show child attributes
Search the web to provide better responses.
The member of the chat
Show child attributes
Show child attributes
The role of the member in the chat
ADMIN, MEMBER Schema for the public contact channel
Show child attributes
Show child attributes
ID of the connection integration
internal, custom, whatsapp_bot, instagram_dm, slack_bot, telegram_bot, gmail, google_calendar The unique identifier for the contact channel, e.g Phone Number
The display name for the contact channel, e.g X Handle
The display name for the contact channel, e.g X Display Name
The avatar for the contact channel, e.g X Avatar URL
The country code associated with the contact channel, e.g US for United States
The user agent associated with the contact channel
The IP address associated with the contact channel
The language code associated with the contact channel, e.g en for English
A link to the contact channel, e.g a link to the social media profile
Error message if the message failed
The usage information for the message
Show child attributes
Show child attributes
Number of input tokens used by the model
Number of output tokens generated by the model
Total number of tokens used by the model
Number of reasoning tokens used by the model
Number of cached input tokens used by the model
Was this page helpful?
[
{
"id": "<string>",
"title": "<string>",
"model": "<string>",
"members": [
{
"id": "<string>",
"role": "ADMIN",
"user": {
"id": "<string>",
"name": "<string>",
"avatar": "<string>"
},
"session": {
"id": "<string>"
},
"contact_channel": {
"id": "<string>",
"channel_type": "internal",
"channel_id": "<string>",
"channel_name": "<string>",
"channel_display_name": "<string>",
"channel_avatar": "<string>",
"country": "<string>",
"agent": "<string>",
"ip": "<string>",
"language": "<string>",
"contact": {
"id": "<string>",
"name": "<string>",
"blocked": true
},
"link": "<string>"
}
}
],
"temporary": true,
"visibility": "PRIVATE",
"pinned": true,
"status": "RUNNING",
"shared_url": "<string>",
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"tools": [
{
"name": "<string>",
"display_name": "<string>",
"action_name": "<string>",
"description": "<string>",
"icon": "StepFormIcon",
"icon_url": "<string>",
"connection_id": "<string>",
"parameters": {},
"enabled_by_default": true,
"callback": "<string>"
}
],
"features": {
"web_search": {},
"reasoning": {
"effort": "low"
}
},
"org_id": "<string>",
"state": {
"id": "<string>",
"state": "OPEN",
"integration_id": "internal",
"assistant_id": "<string>",
"assistant_integration_id": "<string>",
"conversation_id": "<string>",
"ai_enabled": true,
"admin_unseen_count": 123,
"user_unseen_count": 123,
"assistant_integration": {
"id": "<string>",
"enabled": true
},
"assigned_user": {
"id": "<string>",
"name": "<string>",
"email": "[email protected]",
"avatar": "<string>",
"seen_at": "2023-12-25"
},
"assigned_at": "2023-12-25",
"assistant_config": {
"language": "auto",
"model": "<string>",
"stt": {
"model": "<string>"
},
"tts": {
"model": "<string>",
"voice_id": "<string>"
},
"conversation": {
"thread_mode": "new",
"enable_memories": true,
"enable_end_conversation_tool": true,
"enable_transfer_to_human_tool": true,
"welcome_banner": "<string>",
"suggested_messages": [
"<string>"
],
"auto_intro_message": "<string>",
"enable_private_chats": true
},
"knowledge_scope": "all",
"instructions": "<string>"
}
},
"link": "<string>",
"last_message": {
"id": "<string>",
"role": "user",
"model": "<string>",
"status": "RUNNING",
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"messages": [
{
"role": "system",
"parts": [
{
"type": "text",
"text": "<string>",
"audio": {
"id": "<string>",
"file_path": "<string>",
"file_filename": "document.pdf",
"file_size": 1024,
"file_mimetype": "application/pdf",
"file_url": "<string>",
"created_at": "2023-12-25"
},
"start_timestamp": 123,
"end_timestamp": 123
}
]
}
],
"tools": [
{
"name": "<string>",
"display_name": "<string>",
"action_name": "<string>",
"description": "<string>",
"icon": "StepFormIcon",
"icon_url": "<string>",
"connection_id": "<string>",
"parameters": {},
"enabled_by_default": true,
"callback": "<string>"
}
],
"features": {
"web_search": {},
"reasoning": {
"effort": "low"
}
},
"member": {
"id": "<string>",
"role": "ADMIN",
"user": {
"id": "<string>",
"name": "<string>",
"avatar": "<string>"
},
"session": {
"id": "<string>"
},
"contact_channel": {
"id": "<string>",
"channel_type": "internal",
"channel_id": "<string>",
"channel_name": "<string>",
"channel_display_name": "<string>",
"channel_avatar": "<string>",
"country": "<string>",
"agent": "<string>",
"ip": "<string>",
"language": "<string>",
"contact": {
"id": "<string>",
"name": "<string>",
"blocked": true
},
"link": "<string>"
}
},
"error": "<string>",
"usage": {
"input_tokens": 123,
"output_tokens": 123,
"total_tokens": 123,
"reasoning_tokens": 123,
"cached_input_tokens": 123
}
}
}
]