import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/playground-conversations/"
payload = {
"agent_settings": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Analysis Session",
"type": "playground",
"tags": ["analysis", "review"],
"conversation_instructions": "Focus on financial data extraction"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agent_settings: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: 'Analysis Session',
type: 'playground',
tags: ['analysis', 'review'],
conversation_instructions: 'Focus on financial data extraction'
})
};
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 POST \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/playground-conversations/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agent_settings": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Analysis Session",
"type": "playground",
"tags": [
"analysis",
"review"
],
"conversation_instructions": "Focus on financial data extraction"
}
'{
"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": "User not found"
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}Create conversation
Create a new AI-powered conversation.
Impersonation:
- When using impersonation, the conversation is created as the impersonated user
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/playground-conversations/"
payload = {
"agent_settings": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Analysis Session",
"type": "playground",
"tags": ["analysis", "review"],
"conversation_instructions": "Focus on financial data extraction"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agent_settings: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: 'Analysis Session',
type: 'playground',
tags: ['analysis', 'review'],
conversation_instructions: 'Focus on financial data extraction'
})
};
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 POST \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/playground-conversations/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agent_settings": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Analysis Session",
"type": "playground",
"tags": [
"analysis",
"review"
],
"conversation_instructions": "Focus on financial data extraction"
}
'{
"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": "User not found"
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}Authorizations
Use Authorization: Bearer
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
Body
ID of the agent settings to use
Conversation name (auto-generated if not provided)
"Analysis Session"
Conversation type
Tags for organizing conversations
["analysis", "review"]
Custom instructions for this conversation
"Focus on financial data extraction"
Response
Conversation created successfully
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