SYsymbol-chat
capsule

Get a single capsule by id

Changed on
get/api/preview/capsules/{id}

Request

  • Base URL
    https://symbol.chat (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or API key in cookie __Secure-next-auth.session-token
    • or OAuth 2
      Authorization codehttps://mcp.symbol.chat/authorize
      Token URLhttps://mcp.symbol.chat/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

UUID v4 string

Query parameters

include_image_data'1'

When 1, inline image attachment bytes are embedded in the response.

include_file_data'1'

When 1, inline non-image file attachment bytes are embedded in the response (issue #2001).

omit_derived_pdf_data'1'

With include_file_data=1 (or include_files: true on mention resolve), a PDF whose text or page images are in the response is not also inlined as a file; it carries file_data_omitted.reason: derived_instead and its download_url. A PDF nothing could be read from is still inlined. Ignored without the file opt-in.

editor_snapshot'1'

When 1, the response adds editor_snapshot (issue #3078): the capsule's field values, its Type's field schema and the edit token, read together under one snapshot, for an editor to open from or recover to. Only GET /capsules/{id} reads it.

Response

Successful response

agent_metaobject nullable
alias_droppedboolean
alias_reclaimableboolean
alias_reclaimedboolean
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
deadCrossRefsobject

Cited @type/ref tokens whose capsule was deleted, keyed like resolvedCrossRefs. Never resolved to a capsule that now holds the same number or alias.

deleted_atstring nullable
draftAttachmentsMapobject
dropped_tagsstring[]

The tag labels this request sent that were not stored, trimmed, in the order sent: a label that is purely numeric or has no letter or number. Present only beside tags_dropped: true, on the caller's own create or update.

editor_snapshot_unavailable'not_editable' | 'approved_delivery' | 'archived' | 'not_found' | 'type_unavailable'

Why editor_snapshot is null: not_editable (no edit right), approved_delivery (a protected capsule delivered as its approved projection), archived, not_found, or type_unavailable.

effective_guidance_hashstring
evicted_version_numsinteger[]
field_valuesobject
flag_reasonstring nullable
flagged_atstring nullable
idstring required

UUID v4 string

inbound_ref_countinteger
incompleteboolean
is_agentboolean
is_encryptedboolean
is_promptboolean
is_sharedboolean
is_staleboolean
languagestring nullable
last_entry_atstring nullable
last_fetched_atstring nullable
lifecycle_updated_atstring nullable

When the capsule's age clock was last renewed. Staleness and auto-archive measure from it. Equal to updated_at except after a Type field rename or retype, which advances updated_at (the edit token) and keeps this. Read-only; absent from older servers.

log_entriesobject[]
log_entries_next_cursorstring nullable
log_entries_totalinteger
log_entry_orderstring
log_field_schemaobject[]
log_paragraph_rendering'plain' | 'markdown'
log_period_keystring nullable
log_period_nextstring nullable
log_period_prevstring nullable
marked_completeboolean
missing_required_fieldsstring[]
owned_logobject nullable

On an owner: its owned log, or null until the first append creates it or when you may not read the log (the entries are then empty too).

owner_capsuleobject nullable

On an owned log, web shape only: the capsule it belongs to, present only when you may read that capsule.

owner_capsule_idstring nullable

The owning capsule's id, when this is an owned log and you may read the owner; otherwise null. Always null in write responses.

owner_log_bindingboolean
owner_log_typeobject nullable
preview_fieldsobject[]
project_colorstring nullable
project_idstring nullable
project_namestring nullable
project_slugstring nullable
prompt_metaobject nullable
prompt_namestring nullable
ref_idinteger
resolvedCrossRefsobject
rolloverstring nullable
share_display'article' | 'prompt' | 'showcase' nullable
share_display_effective'article' | 'prompt' | 'showcase' nullable
share_display_rendered'article' | 'prompt' | 'showcase'

What the capsule's shared page renders, after the cover fallback: a Showcase with no cover image renders as article. Present on server single-capsule reads and write responses, absent where cover presence was not looked up.

share_display_unhonored'showcase_no_cover' nullable

Why share_display_rendered differs from share_display_effective: showcase_no_cover when Showcase was chosen and the capsule has no cover image, else null. Present exactly when share_display_rendered is.

skill_name_nextstring

Present with name_changed: the name the next publish would serve it under.

skill_name_servedstring

Present with name_changed: the name the skill is served under now.

skill_republish_neededboolean
skill_republish_reasonsstring[]

Why the published skill is stale: name_changed (the next publish renames it, see skill_name_served and skill_name_next) and/or content_changed (its content is behind this capsule).

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_guidance_notestring
type_guidance_status'current' | 'delivered'
type_guidance_status_reasonstring
type_iconstring nullable
type_idstring

UUID v4 string

type_log_entry_orderstring nullable
type_log_target_type_idstring nullable
type_namestring
type_paragraph_renderingstring nullable
type_rolloverstring nullable
type_share_templatestring nullable
type_slugstring
type_structurestring nullable
unreferencedboolean
updated_atstring
version_skip_reasonstring nullable
version_skippedboolean
viewer_can_writeboolean
visibility'self' | 'link' | 'public' | 'org_view' | 'org_edit'
warningsstring[]
workspace_idstring nullable

Changes

  • 24536ef7ac40Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • fd7b0a7085e4Revision changes
    • info

      added the new optional query request parameter editor_snapshot

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status