latestOpenAPI 3.1.02026-08-18490237.4 KB

c690ac22ae04

type

Create a type

post/api/preview/types

Request body

color'violet' | 'sage' | 'ocean' | 'amber' | 'rose' | 'slate' | 'teal' | 'plum'

Tint-token color key for this Type's icon, from the closed palette. Omit for a color derived deterministically from the slug.

content_md_maxinteger

Maximum content_md length (UTF-16 code units) for capsules of this Type. Floor 0 disables bodies (title-only Type); ceiling 90000. Defaults to 20000 when omitted.

default_project_idstring nullable

UUID v4 string

expire_after_daysinteger

Archive capsules of this Type after N days. Must exceed stale_after_days.

field_body_templatestring

Deprecated alias for output_template, accepted for backward compatibility. Prefer output_template; if both are sent, output_template wins.

field_content_maxinteger

Maximum SUMMED length (UTF-16 code units) of one write's field_values — a single capsule's field values, or a single log entry's. The fields-side companion to content_md_max; for a log Type (and any Type with content_md_max: 0) it is the only content cap that applies. Floor 0 forbids field content; ceiling 90000. Defaults to 90000 when omitted (no change from today). Part of the 'Limits / guardrails' class — editable by an AI/MCP caller only when a person grants that class.

field_count_maxinteger

Maximum number of typed fields this Type's field_schema may declare — a guardrail bounding schema size (never capsule content), in the 'Limits / guardrails' class for AI-permission purposes. Floor 0 forbids fields; ceiling 50 (the global limit). Defaults to 50 when omitted.

field_count_mininteger

Minimum number of fields a freeform capsule must provide (pairs with field_count_max). Floor 0 (no minimum); ceiling 50. Must not exceed field_count_max. Defaults to 0.

field_mode'structured' | 'freeform'

Field-authoring mode: structured (named fields via field_schema, the default) or freeform (per-type policies via freeform_schema, AI names/counts fields). Freeform requires structure: standard.

format'markdown'

Content format the package emits. markdown is the only supported value; it is determined by the package and shown locked in the UI.

guidancestring

Type-level guidance markdown shown to AI assistants when creating or interpreting capsules of this Type.

guidance_maxinteger

Maximum guidance length (UTF-16 code units) for this Type. Floor 0 means the Type carries no guidance; ceiling 5000. Defaults to 5000 when omitted (no change from today). Part of the 'Limits / guardrails' class — editable by an AI/MCP caller only when a person grants that class in the Type's AI permissions.

hide_orphan_warningboolean

Suppress the orphan-capsules banner on this Type's detail page. When omitted or false, the banner is shown whenever the Type contains capsules with zero inbound references.

icon'building' | 'tower' | 'briefcase' | 'landmark' | 'store' | 'users' | 'rocket' | 'box' | 'layers' | 'globe' | 'sparkles' | 'code' | 'book' | 'file-text' | 'notebook' | 'lightbulb' | 'flask' | 'palette' | 'music' | 'camera' | 'image' | 'map-pin' | 'calendar' | 'clipboard' | 'message' | 'heart' | 'star' | 'flag' | 'tag' | 'bookmark' | 'graduation' | 'leaf' | 'compass' | 'puzzle' | 'target' | 'wand'

Icon glyph key for this Type's visual identity, from the closed icon library. Capsules of the Type render it. Omit for a monogram default.

is_encryptedboolean

Enable end-to-end encryption for capsules of this Type. One-way: cannot be reverted.

log_entry_order'newest_first' | 'oldest_first'

Default order a log-structure Type's entry stream renders in: newest_first (default) or oldest_first. The Stream sort toggle seeds from this. Meaningful only when structure = 'log'.

log_mode'period' | 'owned'

Which shape a log-structure Type's capsules take — the two are exclusive. period (default): capsules are dated buckets and appends name the Type. owned: capsules are the dedicated logs of capsules in other Types, appends must name the owner capsule, and rollover/log_timezone are inert. Meaningful only when structure = 'log'.

log_target_type_idstring nullable

UUID v4 string

log_timezonestring

IANA timezone name in which this log Type's daily/weekly/monthly rollover boundary is computed (e.g. "America/New_York"). Default "UTC".

namestring required

Human-readable Type name (e.g. "Recipes", "Snippets").

output_templatestring

Optional output template for a field-structured Type. When set, a capsule's field_values are composed through it into rendered content at read time — {{field_name}} tokens substitute declared field values. Empty means the content is the fields shown as-is (structured content).

package_as'standard' | 'skill' | 'agent'

Default packaging for NEW capsules of this Type. standard (default), skill (new capsules seeded as skills, eligible to publish), or agent (new capsules seeded as Claude Code subagent definitions, syncable to project files, --agents JSON, or a plugin). A default only — never retroactive; each capsule's packaging is individually overridable.

paragraph_rendering'plain' | 'markdown'

How this Type's capsules render standalone paragraph field values in the read view: plain (default) shows literal text; markdown renders them through the sanitized Markdown pipeline. Governs standalone field display only — values interpolated into an output_template body already render as Markdown and are unaffected.

prompt_defaultboolean

When true, capsules created under this Type default their per-capsule prompt facet on (exposed on the MCP prompts surface). Applies to NEW capsules only — never retroactively changes existing capsules.

rollover'daily' | 'weekly' | 'monthly' | 'manual'

Rollover policy for a log-structure Type: daily (default), weekly, monthly, or manual. Governs how appended entries bucket into period capsules. Meaningful only when structure = 'log'.

share_template'article' | 'prompt' | 'showcase'

How this Type's capsules render on a public share page. article (default) is the reading layout; prompt is the grab-and-use template.

slugstring required

URL-safe lowercase slug

slug_sourcestring nullable

Name of a declared text field whose value derives each capsule's alias — the value is normalized (trimmed + lowercased) to the canonical alias, so the retrieval alias can never diverge from the external ID the field holds. Omit or null for no derivation. Structured, non-encrypted, non-log Types only.

stale_after_daysinteger

Mark capsules of this Type as stale after N days.

structure'standard' | 'log'

Capsule body shape for this Type, chosen on the cover page. standard (default) or log. Persisted only; does not change body behaviour.

summarystring

Optional short summary of what the Type holds.

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.

Response

Successful response

ai_settings_policyobject nullable
capsule_countinteger
colorstring nullable
content_bytesinteger nullable
content_md_maxinteger nullable
created_atstring
created_bystring
default_project_idstring nullable
evicted_version_numsinteger[]
expire_after_daysinteger nullable
field_content_maxinteger nullable
field_count_maxinteger nullable
field_count_mininteger nullable
field_modestring nullable
field_schemaobject[] nullable
form_packaged_atstring nullable
formatstring nullable
freeform_schemaobject[] nullable
guidancestring nullable
guidance_hashstring nullable
guidance_maxinteger nullable
guidance_tokenstring nullable
guidance_token_status'ok' | 'not_required' | 'unavailable'
hide_orphan_warningboolean
iconstring nullable
idstring required

UUID v4 string

is_encryptedboolean
last_capsule_atstring nullable
log_addressingobject nullable
log_entry_orderstring nullable
log_modestring nullable
log_owner_typesstring[] nullable
log_targetobject nullable
log_target_type_idstring nullable
log_timezonestring nullable
namestring
output_templatestring nullable
package_asstring nullable
paragraph_renderingstring nullable
prompt_defaultboolean
rolloverstring nullable
share_templatestring nullable
slugstring
slug_sourcestring nullable
stale_after_daysinteger nullable
structurestring nullable
summarystring nullable
updated_atstring
version_skip_reasonstring nullable
version_skippedboolean
warningsstring[]
workspace_idstring nullable
workspace_namestring nullable