capsule

Get Type context (guidance + recent capsules) for AI assistants

Changed on
get/api/preview/capsules/context

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/capsules/context
  • 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

typeIdstring required

The Type whose guidance and capsules to return. Required.

collectionIdstring

A Collection inside the Type (requires typeId); the listing is then narrowed to that Collection's capsules. A Collection that is not in the Type is a 404. For a caller who holds a grant on the Collection but not on the Type, it lists what a library link to that Collection would publish, and the response withholds the Type's guidance (type.type_guidance and guidance_token are null, guidance_references is omitted) and its Type-wide fields such as type.inbound_ref_count.

includestring

Comma-separated opt-in extras, from: collections. collections adds the Type's collections inline as collections, so no second request is needed. An unknown value is refused with 400.

content_level'full' | 'summary' | 'metadata'

Content projection for each capsule. Defaults to full.

archived'true' | 'false'

Set to true to read the Type's archived capsules instead of its active ones.

ref_frominteger

Inclusive lower bound on capsule ref number.

ref_tointeger

Inclusive upper bound on capsule ref number.

created_withinstring

Relative window on creation date: an integer 1-9999 followed by h, d, or w (e.g. 8h, 3d, 2w). The legacy 24h/7d/30d values still work.

created_period'today' | 'yesterday' | 'this_week' | 'last_week' | 'this_month' | 'last_month' | 'this_year'

Named calendar window on creation date, resolved in the effective timezone.

created_afterstring

Inclusive lower bound on creation date. An ISO-8601 instant (2026-09-01T00:00:00Z), or an offset-less date or date-time (2026-09-01) read in the effective timezone.

created_beforestring

Exclusive upper bound on creation date. Same spellings as created_after.

tzstring

IANA timezone name (e.g. America/New_York) that named calendar periods resolve in for this request, overriding the caller's stored timezone.

limitinteger

Page size. Defaults to 200; values above 500 are clamped to 500.

cursorstring

Opaque cursor from a previous page's nextCursor.

wsstring

Optional workspace context. Validated, but the capsules returned are always those of the Type's own workspace.

Response

Successful response

collectionsobject[]
guidance_tokenstring nullable required
guidance_token_status'ok' | 'not_required' | 'unavailable' required
hasMoreboolean
nextCursorstring nullable
totalinteger nullable required

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 new optional query request parameter collectionId

    • 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