List interview drafts
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interview-drafts/"
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}/interview-drafts/', 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}/interview-drafts/ \
--header 'Authorization: Bearer <token>'{
"count": 123,
"next": "<string>",
"previous": "<string>",
"results": [
{
"name": "<string>",
"topic": "<string>",
"instructions": "<string>",
"interview_type": "interview",
"questions": [
"<string>"
],
"topics": [
{
"title": "<string>",
"description": "<string>",
"skill_id": "<string>"
}
],
"planned_minutes": 92,
"assignee_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"invite_emails": [
"[email protected]"
],
"language": "<string>",
"custom_message": "<string>",
"custom_focus": "<string>",
"artifacts": [
{
"slug": "<string>",
"show_to_respondent": false
}
],
"scheduled_send_at": "2023-11-07T05:31:56Z",
"reminders_enabled": false,
"reminder_start_after_days": 2,
"reminder_interval_days": 3,
"reminder_max_count": 3,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name_is_custom": true,
"assignee_emails": [
"[email protected]"
],
"campaign": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"test_runs": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"language": "<string>",
"started_from_topic_index": 123,
"started_from_topic_title": "<string>",
"skipped_topic_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"jumps": [
{
"from_topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"to_topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"at_message_count": 123
}
],
"message_count": 123,
"draft_changed_since_start": true,
"interview_url": "<string>",
"draft_source_session": {
"kind": "clara_fast",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"source_session": {
"kind": "clara_fast",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"reference_documents": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"processing_status": "<string>",
"source_document": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"character_count": 123,
"page_count": 123,
"size_warning": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"reference_documents_warning": "<string>",
"artifact_selection_warning": "<string>",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by_email": "[email protected]",
"created_at": "2023-11-07T05:31:56Z",
"updated_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."
}Interviews
List interview drafts
List the project’s saved-but-unsent interview drafts, most recently updated first. Admin only (like everything pre-send).
view=summary returns overview rows (InterviewDraftSummary) instead of
full drafts — what agent tools list; read a full draft with the detail
endpoint.
GET
/
projects
/
{project_id}
/
interview-drafts
/
List interview drafts
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interview-drafts/"
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}/interview-drafts/', 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}/interview-drafts/ \
--header 'Authorization: Bearer <token>'{
"count": 123,
"next": "<string>",
"previous": "<string>",
"results": [
{
"name": "<string>",
"topic": "<string>",
"instructions": "<string>",
"interview_type": "interview",
"questions": [
"<string>"
],
"topics": [
{
"title": "<string>",
"description": "<string>",
"skill_id": "<string>"
}
],
"planned_minutes": 92,
"assignee_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"invite_emails": [
"[email protected]"
],
"language": "<string>",
"custom_message": "<string>",
"custom_focus": "<string>",
"artifacts": [
{
"slug": "<string>",
"show_to_respondent": false
}
],
"scheduled_send_at": "2023-11-07T05:31:56Z",
"reminders_enabled": false,
"reminder_start_after_days": 2,
"reminder_interval_days": 3,
"reminder_max_count": 3,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name_is_custom": true,
"assignee_emails": [
"[email protected]"
],
"campaign": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"test_runs": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"language": "<string>",
"started_from_topic_index": 123,
"started_from_topic_title": "<string>",
"skipped_topic_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"jumps": [
{
"from_topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"to_topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"at_message_count": 123
}
],
"message_count": 123,
"draft_changed_since_start": true,
"interview_url": "<string>",
"draft_source_session": {
"kind": "clara_fast",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"source_session": {
"kind": "clara_fast",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"reference_documents": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"processing_status": "<string>",
"source_document": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"character_count": 123,
"page_count": 123,
"size_warning": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"reference_documents_warning": "<string>",
"artifact_selection_warning": "<string>",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by_email": "[email protected]",
"created_at": "2023-11-07T05:31:56Z",
"updated_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
BearerAuthTokenAuth
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..
Query Parameters
Response
Successful response