latestOpenAPI 3.1.02026-08-18490237.4 KB
c690ac22ae04
capsule
Resolve a capsule by its @type/ref or @type/alias
get/api/preview/capsules/by-ref
Query parameters
refstring required
The @type-slug/ref or @type-slug/alias to resolve.
The @type-slug/ref or @type-slug/alias to resolve.
Response
Successful response
alias_droppedboolean
alsoAvailableAsSkillstring
archive_event_idstring nullable
archive_reasonstring nullable
archived_atstring nullable
attachmentsobject[]
capsule_keysobject[]
code_excerptstring nullable
content_excerptstring nullable
content_mdstring nullable
content_renderedstring nullable
coverobject nullable
created_atstring
created_bystring
deleted_atstring nullable
draftAttachmentsMapobject
evicted_version_numsinteger[]
field_valuesobject
flag_reasonstring nullable
flagged_atstring nullable
form_answered_atstring nullable
form_responsesobject nullable
idstring required
UUID v4 string
inbound_ref_countinteger
is_encryptedboolean
is_promptboolean
is_staleboolean
languagestring nullable
last_entry_atstring nullable
last_fetched_atstring nullable
log_entriesobject[]
log_entries_next_cursorstring nullable
log_entries_totalinteger
log_entry_orderstring
log_field_schemaobject[]
log_period_keystring nullable
log_period_nextstring nullable
log_period_prevstring nullable
owned_logobject nullable
owner_capsuleobject nullable
owner_capsule_idstring nullable
owner_log_bindingboolean
owner_log_typeobject nullable
project_colorstring nullable
project_idstring nullable
project_namestring nullable
project_slugstring nullable
prompt_metaobject nullable
prompt_namestring nullable
ref_idinteger
resolvedCrossRefsobject
rolloverstring nullable
skill_republish_neededboolean
slugstring nullable
summarystring nullable
summary_staleboolean
summary_updated_atstring nullable
tags_droppedboolean
tags_truncatedboolean
titlestring
token_bindingsobject
type_colorstring nullable
type_content_md_maxinteger nullable
type_guidancestring nullable
type_iconstring nullable
type_idstring
UUID v4 string
type_log_entry_orderstring nullable
type_log_target_type_idstring nullable
type_namestring
type_rolloverstring nullable
type_slugstring
type_structurestring nullable
unreferencedboolean
updated_atstring
version_skip_reasonstring nullable
version_skippedboolean
warningsstring[]
workspace_idstring nullable