latestOpenAPI 3.1.02026-08-18490237.4 KB

c690ac22ae04

capsule

Create a capsule

post/api/preview/capsules

Request body

agentboolean

Package this capsule as a Claude Code agent. Omit to inherit the Type's packaging default; set explicitly to override. Encrypted capsules can't be agents.

categoriesstring[]

Category slugs from the curated taxonomy (max 10). Unknown slugs are rejected with a 400 naming the offending value. Fetch valid slugs from GET /api/preview/categories.

cek_paramsobject

Opaque CEK metadata produced by the client crypto layer

content_mdstring

Markdown body. Empty string for no content. Maximum length is configured per-Type via content_md_max (default 20000, ceiling 90000).

draftAttachmentIdsstring[]

Draft attachment ids to associate on create.

draftIdstring

Draft attachment session id; required when draftAttachmentIds is present.

field_valuesobject

Structured field values keyed by field name. Validated against the Type's field_schema at write time; undeclared keys are rejected.

is_encryptedboolean

is_promptboolean

Expose this capsule on the MCP prompts surface. Omit to inherit the Type's default; set explicitly to override. Toggling it does not move the capsule or change its @type/ref.

project_idstring nullable

UUID v4 string

slugstring nullable

Optional human-readable alias (@type/alias). Lowercase slug, max 60 chars, not purely numeric. Resolves to the same capsule as its numeric ref.

summarystring

Optional short summary (LLM-generated or hand-written).

tagsstring[]

Free-form tags (max 20). Each is normalized to a slug and deduped server-side (e.g. Foo Bar and foo-bar collapse to one). Purely numeric or empty-after-normalization values are dropped.

titlestring required

Human-readable capsule title

type_idstring

Target Type. Omit to fall back to the user's default Type for the workspace.

workspace_idstring nullable

Workspace context. Accepts: "personal" for your personal workspace, an organization workspace name (full or partial — e.g. "Verdant Studio" or "Verdant"), or a workspace UUID. The MCP server resolves names against the user's accessible workspaces; ambiguous or unknown names return an error listing available workspaces — call list_workspaces in that case. Omit to use the default: personal for personal API keys, the bound organization for organization API keys.

wrapped_cekstring

Wrapped per-capsule content-encryption key (E2EE)

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