import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interview-drafts/{draft_id}/local-documents/"
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/{draft_id}/local-documents/', 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/{draft_id}/local-documents/ \
--header 'Authorization: Bearer <token>'{
"count": 123,
"next": "<string>",
"previous": "<string>",
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"file": "<string>",
"type": "agent_settings",
"agent_settings": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"coach_conversation": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_session": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cross_store_conversation": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"interview_draft": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_document": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"claude_file_id": "<string>",
"source": "uploaded",
"document_text": "<string>",
"summary_text": "<string>",
"short_summary_text": "<string>",
"processing_status": "<string>",
"page_count": 123,
"character_count": 123,
"preview_pdf_url": "<string>",
"size_warning": "<string>",
"version_number": 123,
"total_versions": 123
}
]
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}List a draft's reference documents
The documents the interviewer attached to a draft to frame the interview
(CLA-1887). Admin only. Each is a LocalDocument with source: reference;
while processing_status is not completed/failed the parser is still working
and the draft cannot be sent or tested (assign / test-runs return 409).
The same nested route offers the standard local-document actions:
POST bulk-upload/ (multipart files, names deduplicated per draft),
DELETE {id}/, and GET download-all/.
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interview-drafts/{draft_id}/local-documents/"
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/{draft_id}/local-documents/', 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/{draft_id}/local-documents/ \
--header 'Authorization: Bearer <token>'{
"count": 123,
"next": "<string>",
"previous": "<string>",
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"file": "<string>",
"type": "agent_settings",
"agent_settings": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"coach_conversation": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_session": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cross_store_conversation": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"interview_draft": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_document": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"claude_file_id": "<string>",
"source": "uploaded",
"document_text": "<string>",
"summary_text": "<string>",
"short_summary_text": "<string>",
"processing_status": "<string>",
"page_count": 123,
"character_count": 123,
"preview_pdf_url": "<string>",
"size_warning": "<string>",
"version_number": 123,
"total_versions": 123
}
]
}{
"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..