Conversations

List Conversations

This endpoint returns a list of all Conversations created by the account associated with the API Key in use.

get/v2/conversations

Request

Base URL
https://tavusapi.com
URL
https://tavusapi.com/v2/conversations
Auth
API key in header x-api-key

Query parameters

limitinteger

The number of conversations to return per page. Default is 10.

pageinteger

The page number to return. Default is 1.

statusstring

Filter the conversations by status. Possible values: active, ended.

Response

total_countinteger

The total number of conversations given the filters provided.

Example response

{
  "data": [
    {
      "conversation_id": "c123456",
      "conversation_name": "A Meeting with Hassaan",
      "status": "active",
      "conversation_url": "https://tavus.daily.co/c123456",
      "callback_url": "https://yourwebsite.com/webhook",
      "face_id": "rc9cff32ceba",
      "pal_id": "pcb7a34da5fe"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.