c690ac22ae04
Create a type
Request body
Tint-token color key for this Type's icon, from the closed palette. Omit for a color derived deterministically from the slug.
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.
UUID v4 string
Archive capsules of this Type after N days. Must exceed stale_after_days.
Deprecated alias for output_template, accepted for backward compatibility. Prefer output_template; if both are sent, output_template wins.
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.
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.
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-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.
Content format the package emits. markdown is the only supported value; it is determined by the package and shown locked in the UI.
Type-level guidance markdown shown to AI assistants when creating or interpreting capsules of this Type.
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.
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 glyph key for this Type's visual identity, from the closed icon library. Capsules of the Type render it. Omit for a monogram default.
Enable end-to-end encryption for capsules of this Type. One-way: cannot be reverted.
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'.
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'.
UUID v4 string
IANA timezone name in which this log Type's daily/weekly/monthly rollover boundary is computed (e.g. "America/New_York"). Default "UTC".
Human-readable Type name (e.g. "Recipes", "Snippets").
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).
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.
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.
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 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'.
How this Type's capsules render on a public share page. article (default) is the reading layout; prompt is the grab-and-use template.
URL-safe lowercase slug
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.
Mark capsules of this Type as stale after N days.
Capsule body shape for this Type, chosen on the cover page. standard (default) or log. Persisted only; does not change body behaviour.
Optional short summary of what the Type holds.
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
UUID v4 string