List general chat conversations

GET /api/v1/chat/general/history

List general chat conversations

Python

import requests

url = "https://platform.ankra.app/api/v1/chat/general/history"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "conversations": [
    {
      "id": "<string>",
      "user_id": "<string>",
      "organisation_id": "<string>",
      "cluster_id": "<string>",
      "title": "<string>",
      "question_type": "<string>",
      "messages": [
        {
          "role": "<string>",
          "content": "<string>",
          "id": "<string>",
          "timestamp": "2023-11-07T05:31:56Z",
          "triage": {},
          "context": {},
          "complete": {},
          "toolsUsed": [
            {
              "id": "<string>",
              "toolName": "<string>",
              "status": "<string>",
              "resultCount": 123
            }
          ]
        }
      ],
      "context_summary": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "cluster_name": "<string>"
    }
  ],
  "total_count": 123
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization · string | null

Query Parameters

show_all · boolean · default: true

Show all conversations including deleted

Example:

true

limit · integer · default: 50

Maximum number of conversations to return

Required range: 1 <= x <= 1000

Example:

50

offset · integer · default: 0

Number of conversations to skip

Required range: x >= 0

Example:

0

Response

200

application/json

Chat conversations retrieved successfully

conversations · ChatConversation · object[] · required

Show child attributes

total_count · integer · required