List Conversations

Retrieves the conversations for the given agent ID.

GET /1/agents/{agent_id}/conversations

List Conversations

cURL

curl --request GET \
  --url https://{APPLICATION_ID}.algolia.net/agent-studio/1/agents/{agent_id}/conversations \
  --header 'X-Algolia-API-Key: <x-algolia-api-key>' \
  --header 'X-Algolia-Application-Id: <x-algolia-application-id>'

200

{
  "data": [
    {
      "id": "<string>",
      "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "title": "<string>",
      "lastActivityAt": "2023-11-07T05:31:56Z",
      "userToken": "<string>",
      "isFromDashboard": false,
      "messageCount": 0,
      "totalInputTokens": 0,
      "totalOutputTokens": 0,
      "totalTokens": 0,
      "conversationMetadata": {
        "cachedAt": "2023-11-07T05:31:56Z"
      },
      "feedback": [
        {
          "id": "<string>",
          "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "messageId": "<string>",
          "vote": 123,
          "tags": [
            "<string>"
          ],
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "notes": "<string>",
          "model": "<string>"
        }
      ]
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "totalCount": 123,
    "totalPages": 123
  }
}

Required ACL: logs

Headers

X-Algolia-API-Key · string · required

X-Algolia-Application-Id · string · required

X-Algolia-Secure-User-Token · string | null

Path Parameters

agent_id · string<uuid> string · required

Query Parameters

startDate · string<date> | null

Filter conversations created after this date (format: YYYY-MM-DD)

endDate · string<date> | null

Filter conversations created before this date (format: YYYY-MM-DD)

includeFeedback · boolean | null · default: false

Include feedback per conversation

feedbackVote · integer | null

Filter by feedback value (requires includeFeedback=true)

Required range: 0 <= x <= 1

page · integer · default: 1

Page number

Required range: x >= 1

limit · integer · default: 20

Items per page

Required range: 1 <= x <= 100

Response

200

application/json

Successful Response

data · ConversationBaseResponse · object[] · required

Show child attributes

pagination · PaginationMetadata · object · required

Show child attributes