import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interviews/{interview_id}/artifacts/"
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}/interviews/{interview_id}/artifacts/', 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}/interviews/{interview_id}/artifacts/ \
--header 'Authorization: Bearer <token>'[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"title": "<string>",
"semantic_type": "brief",
"technical_type": "markdown",
"in_scope": true,
"display_order": 123,
"group": "<string>",
"definition_short": "<string>",
"head_version_number": 123,
"head_updated_at": "2023-11-07T05:31:56Z",
"version_count": 123,
"can_delete": true,
"payload": "<unknown>"
}
]Artifacts shown beside an interview
The knowledge-store artifacts the interview’s draft chose to show its respondent, read-only, at the latest versions the interviewer’s prompt reads (CLA-1931). Readable by the respondent (interview-only access is enough) and by data readers.
Only the selected artifacts marked show_to_respondent. Empty when none are,
when the draft chose none, for interviews sent before the selection existed and
for onboarding — none of these show an artifact panel.
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interviews/{interview_id}/artifacts/"
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}/interviews/{interview_id}/artifacts/', 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}/interviews/{interview_id}/artifacts/ \
--header 'Authorization: Bearer <token>'[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"title": "<string>",
"semantic_type": "brief",
"technical_type": "markdown",
"in_scope": true,
"display_order": 123,
"group": "<string>",
"definition_short": "<string>",
"head_version_number": 123,
"head_updated_at": "2023-11-07T05:31:56Z",
"version_count": 123,
"can_delete": true,
"payload": "<unknown>"
}
]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 interview
Response
The artifacts, in catalog order
What the artifact means in the knowledge store. Predefined types are
seeded by the platform; custom artifacts are user-created.
brief, project_plan, mental_map, general_knowledge, playbooks, library_description, design_templates, custom Storage/editing format of the artifact's payload — string for
markdown and bpmn_xml, object for mental_map, array for
playbook_list and design_template_list.
markdown, mental_map, playbook_list, design_template_list, bpmn_xml Catalog group label; empty for predefined artifacts (their section derives
from semantic_type) and for ungrouped custom ones. "Foundation" and
"Other" are reserved for UI-derived sections and cannot be set; the four
standard section names ("Project Management", …) are NOT reserved — a
custom artifact may use one to file itself alongside the predefined
artifacts.
The artifact content (head version), shaped by its technical_type.