import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/playground-conversations/{conversation_id}/"
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/{conversation_id}/', 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/{conversation_id}/ \
--header 'Authorization: Bearer <token>'{
"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."
}Get conversation
Retrieve a conversation with its complete chat history.
Access Control:
- Admins can access any conversation
- Regular users can access their own conversations
- All project members can access shared conversations via direct URL
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/playground-conversations/{conversation_id}/"
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/{conversation_id}/', 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/{conversation_id}/ \
--header 'Authorization: Bearer <token>'{
"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..
Path Parameters
UUID of the project
UUID of the conversation
Query Parameters
Set to "true" to allow retrieving an archived conversation. Defaults to false.
true, false Response
Successful response
ID of the user who created the conversation
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Whether the conversation is shared with all workspace members
Whether the current user can send messages to this conversation. For shared conversations, only the creator and admins can send messages.
Whether the conversation has been soft-archived
Timestamp when the conversation was archived, null if not archived