SYsymbol-chat
share

Resolve a share token into the underlying resource snapshot

Changed on
get/api/preview/share/resolve

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.

Query parameters

tokenstring required

The shr_… share token to resolve. Required.

presentation'1'

Metered capsule read only. When 1, the response adds presentation: the recipient's view of the capsule, on the same one view.

verify'1'

Non-consuming verification read. When 1, the authorization chain runs but no view is consumed and the response is identity-only for every target kind.

include_image_data'1'

Metered capsule read only. When 1, inline image attachment bytes are embedded in the response.

include_file_data'1'

Metered capsule read only. 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.

shape'mcp'

Metered capsule read only. When mcp, each attachment record is trimmed to the assistant shape: its id, file name, MIME type, integer size, image dimensions, availability and expiry when set, created_at, download_url and embed_markdown (issue #2753). Without it the record is unchanged.

Response

Successful response

archived_atstring nullable
attachmentsobject[]
content_excerptstring nullable
content_mdstring 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
field_valuesobject nullable
idstring required

UUID v4 string

incompleteboolean
is_encryptedboolean
is_promptboolean
is_staleboolean
languagestring nullable
project_idstring nullable
prompt_metaobject nullable
refstring

Capsule reference, @<type_slug>/<ref_id>, when the response carries it.

ref_idinteger

Numeric capsule ref id.

resolvedRefsobject
share_display'article' | 'prompt' | 'showcase' nullable
slugstring nullable
summarystring nullable
titlestring
type_guidancestring nullable
type_idstring

UUID v4 string

type_namestring
type_slugstring
updated_atstring
viewer_can_writeboolean
workspace_idstring nullable

Changes

  • 24536ef7ac40Revision changes
    • info

      added the new optional query request parameter presentation

    • info

      added the optional property to the response with the status

  • fd7b0a7085e4Revision changes
    • info

      added the optional property to the response with the status