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)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/playground-conversations/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/playground-conversations/ \
--header 'Authorization: Bearer <token>'{
"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"
}
]
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}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)
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)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/playground-conversations/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/playground-conversations/ \
--header 'Authorization: Bearer <token>'{
"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"
}
]
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Authorizations
Use Authorization: Bearer <token>. The token is either a user token / OAuth access
token, or a service-account API key (cfk_...). A key is valid on every endpoint and
acts as its service account, an organization member with per-store permissions.
Refused keys answer 403 with Invalid API key., API key revoked.,
API key expired. or API key disabled..
Headers
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
UUID of the project
Query Parameters
Filter by tags (OR logic). Can be specified multiple times or comma-separated.
Set to "true" to filter for conversations with no tags
true, false Search text within the conversation name or chat history (case-insensitive)
Only conversations created by this user — me, a user id or an email. An unknown user returns no rows. Non-admins only ever see their own conversations, so this cannot widen their list.
Only conversations run with this agent (agent settings id).
Only conversations created at or after this ISO 8601 datetime.
Only conversations created strictly before this ISO 8601 datetime.
Only conversations last active (updated) at or after this ISO 8601 datetime.
Only conversations last active (updated) strictly before this ISO 8601 datetime.
Sort order. -created_at (newest first, default), created_at (oldest first) or -updated_at (most recent activity first).
-created_at, created_at, -updated_at Set to "true" to include archived conversations in results. Defaults to false (active conversations only).
true, false Maximum number of results per page
1 <= x <= 1000Number of results to skip for pagination
x >= 0