Skip to main content
GET
/
chats
/
{chat_id}
Get Chat
curl --request GET \
  --url https://api.example.com/chats/{chat_id}
{
  "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_transfer_to_human_tool": true,
        "welcome_banner": "<string>",
        "suggested_messages": [
          "<string>"
        ],
        "auto_intro_message": "<string>",
        "enable_end_conversation_tool": true,
        "enable_block_contact_tool": true,
        "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

​
chat_id
string
required

Chat ID

Response

200 - application/json
​
id
string
required
​
title
string | null
required

The title of the chat

​
model
string
required

The model used for the chat

​
members
object[]
required

The members of the chat

​
temporary
boolean
required

Whether the chat is temporary and would be deleted after 24 hours of last activity

​
visibility
enum<string>
required

The visibility of the chat

Available options:
PRIVATE,
PUBLIC_READ,
PUBLIC_WRITE
​
pinned
boolean
required

Whether the chat is pinned in the user interface

​
status
enum<string>
required

The status of the chat

Available options:
RUNNING,
COMPLETED,
FAILED,
CANCELED
​
shared_url
string | null
required

The shared URL of the chat, if it is shared

​
created_at
string<date> | null
required
​
updated_at
string<date> | null
required
​
tools
object[]

The tools available in the chat

​
features
object

Enabled features for the model

​
org_id
string
​
state
object

Schema for the chat state

​
link
string

The link to the chat in the integration

​
last_message
object

The chat message schema