Archive conversation

import requests

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

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

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

print(response.text)

const options = {method: 'DELETE', 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));

{
  "error": "Authentication credentials were not provided."
}

{
  "error": "User not found"
}

{
  "error": "Not found."
}

Conversations

Archive conversation

Soft-archive a conversation. The conversation is hidden from default list/get endpoints but is preserved in the database along with all linked feedback.

To permanently delete an archived conversation, use the permanent_delete action. To restore an archived conversation, use the unarchive action.

Access Control:

Admins can archive any conversation
Regular users can only archive conversations they created

Impersonation:

When using impersonation, the ownership check is performed against the impersonated user

DELETE

projects

{project_id}

playground-conversations

{conversation_id}

Archive conversation

import requests

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

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

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

print(response.text)

const options = {method: 'DELETE', 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));

{
  "error": "Authentication credentials were not provided."
}

{
  "error": "User not found"
}

{
  "error": "Not found."
}

Authorizations

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

conversation_id

string<uuid>

required

UUID of the conversation

Response

Conversation archived successfully

Concepts

Endpoints

Archive conversation

Authorizations

Headers

Path Parameters

Response