latestOpenAPI 3.1.02026-08-18490237.4 KB

c690ac22ae04

capsule

Update a capsule

put/api/preview/capsules/{id}

Path parameters

idstring required

UUID v4 string

Request body

agentboolean

Package this capsule as a Claude Code agent (true) or stop packaging it (false). Omit to leave unchanged. An agent's system prompt is its resolved body — its authored markdown, or its Type's output_template when it borrows one, with its field values composed in whenever the Type declares fields (those fields are prompt inputs, not dropped data); its alias is its name, and its summary is its description; encrypted capsules can't be agents.

categoriesstring[]

Replace the capsule's categories. Omit to leave unchanged; send [] to clear. Slugs from the curated taxonomy; unknown slugs 400.

cek_paramsobject

Opaque CEK metadata produced by the client crypto layer

client_updated_atstring date-time

Optimistic-concurrency token. ISO-8601 datetime WITH offset (Z or ±HH:MM); pass the value returned by get_capsule's updated_at field verbatim. (Tightened from legacy: bare ISO without offset is now rejected as a 422 instead of silently bypassing OCC.) If the server's stored updated_at differs, the request 409s.

content_mdstring nullable

Markdown body (source of truth). Omit to leave unchanged; send an empty string to clear it (the blank is honoured — the Type template is NOT re-inherited); send null to revert to borrowing the Type's output template live (un-fork), which also resets token_bindings. Maximum length is configured per-Type via content_md_max (default 20000, ceiling 90000).

field_valuesobject

Replace the capsule's structured field values. Omit to leave unchanged; send {} to clear. Validated against the Type's field_schema.

is_encryptedboolean

One-way: set to true to enable E2EE on this capsule. Cannot be reverted to false.

is_promptboolean

Expose this capsule on the MCP prompts surface, or remove it. Toggling does not move the capsule or change its @type/ref. Omit to leave unchanged.

project_idstring nullable

UUID v4 string

republishboolean

For a capsule published as a skill: whether editing it auto-republishes the skill so the served content follows the edit (default true). Send false to leave the published skill stale and republish manually. No effect on capsules that aren't published skills.

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 nullable

Short summary; send null to clear.

tagsstring[]

Replace the capsule's tags. Omit to leave unchanged; send [] to clear. Free-form; normalized to slugs and deduped server-side.

titlestring

New capsule title

token_bindingsobject

Per-token prompt bindings ({ token: { kind: 'field'|'open', required?, description? } }). Partial map, merged with the stored set. Web-editor only; the body remains the sole way to add or remove a token.

wrapped_cekstring

Wrapped CEK; required when enabling encryption.

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