Skip to main content
GET
Retrieve an artifact

Authorizations

Authorization
string
header
required

Use Authorization: Bearer

Path Parameters

project_id
string<uuid>
required

UUID of the project

slug
string
required

Slug of the artifact within the project's catalog

Query Parameters

version
integer

Version number to read instead of the head version.

Response

Successful response

id
string<uuid>
slug
string
title
string
semantic_type
enum<string>

What the artifact means in the knowledge store. Predefined types are seeded by the platform; custom artifacts are user-created.

Available options:
brief,
mental_map,
general_knowledge,
playbooks,
library_description,
design_templates,
custom
technical_type
enum<string>

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.

Available options:
markdown,
mental_map,
playbook_list,
design_template_list,
bpmn_xml
in_scope
boolean
display_order
integer
group
string

Catalog group label; empty for ungrouped artifacts. "Foundation" and "Other" are reserved for UI-derived sections and cannot be set.

definition_short
string
head_version_number
integer | null
head_updated_at
string<date-time> | null
version_count
integer
can_delete
boolean
definition_long
string
format_description
string

Custom artifacts only; empty string for predefined types.

capture_discipline
string

Custom artifacts only; empty string for predefined types.

selected_version_number
integer | null
payload
any

Content of the selected version; shape depends on technical_type. Null when the artifact has no versions.