List conversations

Retrieve all conversations for a project with optional filtering.

Access Control:

• Admins see all conversations (including shared ones)
• Regular users see only conversations they created (including their own shared ones)
• Shared conversations from other users are not shown in the list but are accessible via direct URL

Impersonation:

• When using impersonation, returns conversations created by the impersonated user

Filtering:

• Tags filtering uses OR logic (matches any of the provided tags)
• Text filtering uses AND logic (combined with tag filters)

GET /projects/{project_id}/playground-conversations

List conversations

Python

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/playground-conversations/"

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

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

print(response.text)

200

{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "type": "<string>",
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "chat_history": [
        {
          "role": "user",
          "content": "<string>",
          "type": "message",
          "query_id": 123,
          "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "used_tokens_input": 123,
          "used_tokens_output": 123,
          "timestamp": "2023-11-07T05:31:56Z",
          "tool_type": "<string>",
          "input_parameters": {},
          "results": [
            "<unknown>"
          ]
        }
      ],
      "agent_settings": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agent_settings_name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "message_count": 123,
      "tool_call_count": 123,
      "tokens": {
        "input": 123,
        "output": 123,
        "total": 123
      },
      "tags": [
        "<string>"
      ],
      "conversation_instructions": "<string>",
      "is_shared": false,
      "can_send_messages": true,
      "is_archived": false,
      "archived_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

BearerAuthTokenAuth

Authorization · string · header · required

Use Authorization: Bearer

Headers

X-Impersonate-Email · string<email>

Email of the user to impersonate. Requires CAN_IMPERSONATE_OTHER_USERS permission. If the target user is not found or does not have access to the project, the request proceeds as the authenticated user. Contact Clarifeye to enable this permission.

Path Parameters

project_id · string<uuid> · required

UUID of the project

Query Parameters

tags · string[]

Filter by tags (OR logic). Can be specified multiple times or comma-separated.

no_tags · enum<string>

Set to "true" to filter for conversations with no tags

Available options: true, false

text · string

Search text within chat history (case-insensitive)

include_archived · enum<string>

Set to "true" to include archived conversations in results. Defaults to false (active conversations only).

Available options: true, false

limit · integer · default: 100

Maximum number of results per page

Required range: 1 <= x <= 1000

offset · integer · default: 0

Number of results to skip for pagination

Required range: x >= 0

Response

200

application/json

Successful response

count · integer

Total number of results

next · string<uri> | null

URL to next page of results

previous · string<uri> | null

URL to previous page of results

results · object[]

Show child attributes