import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/artifacts/{slug}/"
payload = {
"title": "<string>",
"group": "<string>",
"definition_short": "<string>",
"format_description": "<string>",
"capture_discipline": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
group: '<string>',
definition_short: '<string>',
format_description: '<string>',
capture_discipline: '<string>'
})
};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/artifacts/{slug}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request PATCH \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/artifacts/{slug}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"group": "<string>",
"definition_short": "<string>",
"format_description": "<string>",
"capture_discipline": "<string>"
}
'{
"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,
"definition_long": "<string>",
"format_description": "<string>",
"capture_discipline": "<string>",
"selected_version_number": 123,
"payload": "<unknown>"
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Update a custom artifact
Update a custom artifact’s metadata (title, group, definitions). Only fields present in the request are touched. Predefined artifacts cannot be edited. Requires admin permission.
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/artifacts/{slug}/"
payload = {
"title": "<string>",
"group": "<string>",
"definition_short": "<string>",
"format_description": "<string>",
"capture_discipline": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
group: '<string>',
definition_short: '<string>',
format_description: '<string>',
capture_discipline: '<string>'
})
};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/artifacts/{slug}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request PATCH \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/artifacts/{slug}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"group": "<string>",
"definition_short": "<string>",
"format_description": "<string>",
"capture_discipline": "<string>"
}
'{
"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,
"definition_long": "<string>",
"format_description": "<string>",
"capture_discipline": "<string>",
"selected_version_number": 123,
"payload": "<unknown>"
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Authorizations
Use Authorization: Bearer
Path Parameters
UUID of the project
Slug of the artifact within the project's catalog
Body
Response
Updated
What the artifact means in the knowledge store. Predefined types are
seeded by the platform; custom artifacts are user-created.
brief, 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 ungrouped artifacts. "Foundation" and "Other" are reserved for UI-derived sections and cannot be set.
Custom artifacts only; empty string for predefined types.
Custom artifacts only; empty string for predefined types.
Content of the selected version; shape depends on
technical_type. Null when the artifact has no versions.