v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Conversations

List conversations

Retrieve a list of all AI conversations configured by the user. Supports PostgREST-style query parameters for filtering. Examples are included for the standard metadata fields, but you can filter on any field in the metadata JSON object. For example, to filter by a custom field metadata->custom_field, use metadata->custom_field=eq.value.

get/ai/conversations

Query parameters

idstring

Filter by conversation ID (e.g. id=eq.123)

namestring

Filter by conversation Name (e.g. name=like.Voice%)

created_atstring

Filter by creation datetime (e.g., created_at=gte.2025-01-01)

last_message_atstring

Filter by last message datetime (e.g., last_message_at=lte.2025-06-01)

metadata->assistant_idstring

Filter by assistant ID (e.g., metadata->assistant_id=eq.assistant-123)

metadata->call_control_idstring

Filter by call control ID (e.g., metadata->call_control_id=eq.v3:123)

metadata->telnyx_agent_targetstring

Filter by the phone number, SIP URI, or other identifier for the agent (e.g., metadata->telnyx_agent_target=eq.+13128675309)

metadata->telnyx_end_user_targetstring

Filter by the phone number, SIP URI, or other identifier for the end user (e.g., metadata->telnyx_end_user_target=eq.+13128675309)

metadata->telnyx_conversation_channelstring

Filter by conversation channel (e.g., metadata->telnyx_conversation_channel=eq.phone_call)

limitinteger

Limit the number of returned conversations (e.g., limit=10)

orderstring

Order the results by specific fields (e.g., order=created_at.desc or order=last_message_at.asc)

orstring

Apply OR conditions using PostgREST syntax (e.g., or=(created_at.gte.2025-04-01,last_message_at.gte.2025-04-01))

Response

Successful Response

Example response

{
  "data": [
    {
      "created_at": "2025-04-15T13:07:28.764Z",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "last_message_at": "2025-04-15T13:07:28.764Z",
      "metadata": {
        "assistant_id": "assistant-123",
        "telnyx_agent_target": "+13128675309",
        "telnyx_conversation_channel": "sms",
        "telnyx_end_user_target": "+13128675309"
      }
    }
  ]
}