SYsymbol
mention

Resolve @slug capsule and Type mentions in a single round-trip

Changed on
post/api/preview/mentions/resolve

Request

  • Base URL
    https://symbol.chat (the document declares no server; this is the origin it was published from)
  • URL
    https://symbol.chat/api/preview/mentions/resolve
  • Auth
    • HTTP bearer
    • or API key in cookie __Secure-next-auth.session-token
    • or OAuth 2
      Authorization code: https://mcp.symbol.chat/authorize
      Token URL: https://mcp.symbol.chat/token

Query parameters

wsstring

Optional workspace context for the request. Same value rules as the MCP workspace tool argument. Omit to use the caller's default workspace.

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.

Request body

include_filesboolean

Whether to inline NON-image file attachment payloads (e.g. PDFs) in the response, so a client that cannot follow URLs from tool results can read a file's contents.

include_imagesboolean

Whether to inline image attachment payloads in the response.

promptstring

Free-form text containing @slug/N or @slug references to resolve.

shape'mcp' | 'wide'

Output shape. mcp = compact agent-facing projection; wide = full envelope (default).

type_capsule_limitinteger

Capsules returned per resolved Type mention, 1 to 100. By default one page of up to 50 capsules per Type, packed to the response's size budget; a smaller value narrows the page; a value above 50 returns at most 50, and meta.typeCapsuleLimit reports the value applied.

workspaceIdstring nullable

Workspace context. null = personal workspace; UUID = a specific organization workspace; omit to resolve cross-workspace. Overridden by ?ws= query param when present.

Response

Successful response

capsulesobject required

Capsule buckets: found / not_found / ambiguous. Each found row carries requested_token, the token as sent, so a caller can pair a redirected ref's row with what it asked for.

metaobject
parsedobject
projectsobject
rejectedobject nullable
typesobject required

Changes