import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/artifacts/{slug}/"
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}/artifacts/{slug}/', 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}/artifacts/{slug}/ \
--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,
"definition_long": "<string>",
"format_description": "<string>",
"capture_discipline": "<string>",
"selected_version_number": 123,
"payload": "<unknown>",
"folders": [
{
"path": "<string>",
"description": "<string>",
"rules": [
"<string>"
]
}
]
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Retrieve an artifact
Retrieve one artifact with its definitions and the payload of the
selected version (head by default; pass version to read an older
one). Requires view permission.
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/artifacts/{slug}/"
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}/artifacts/{slug}/', 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}/artifacts/{slug}/ \
--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,
"definition_long": "<string>",
"format_description": "<string>",
"capture_discipline": "<string>",
"selected_version_number": 123,
"payload": "<unknown>",
"folders": [
{
"path": "<string>",
"description": "<string>",
"rules": [
"<string>"
]
}
]
}{
"error": "Authentication credentials were not provided."
}{
"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..
Path Parameters
Response
Successful response
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.