List Conversations

GET /conversations

Api key

Get all conversations

Query parameters

bot_id string

Id of the bot to filter the list of conversations to only those that are using the selected bot.
keyword string

Keyword to filter the list of conversations to only those that at least partially match the conversation name.
includes string

Lists document ids the conversation is focused on.

Value is document_ids.

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- data array[object]
  
  Hide data attributes Show data attributes object
  
  id string
  
  name string Required
  
  bot_id string Required
  
  created_at integer(int64)
  
  Unix timestamp in seconds
- meta object
  
  Hide meta attribute Show meta attribute object
  
  pagination object
  
  Hide pagination attributes Show pagination attributes object
  
  count integer
  
  total integer
  
  per_page integer
  
  total_pages integer
  
  next_page integer | null
  
  previous_page integer | null

GET /conversations

curl \
 --request GET https://getcody.ai/api/v1/conversations \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "bot_id": "string",
      "created_at": 42
    }
  ],
  "meta": {
    "pagination": {
      "count": 42,
      "total": 42,
      "per_page": 42,
      "total_pages": 42,
      "next_page": 42,
      "previous_page": 42
    }
  }
}