SYsymbol
share

Create a share token

Changed on
post/api/preview/share

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/share
  • 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

Request body

expiresAtstring date-time

Optional expiry timestamp; ISO-8601 datetime with offset, in the future. Once reached, the share link returns 404.

maxViewsinteger

Optional view-count cap. Each share-link visit consumes one view.

newboolean

Mint a new link instead of returning the resource's reusable link. Without it, a request with no expiresAt and no maxViews returns the same link every time (reused: true after the first).

resourceIdstring required

UUID v4 string

resourceType'capsule' | 'type' | 'collection' | 'project' required

Type of resource being shared. A Type, Collection or project link is a browsable library of the owner's own publishable capsules.

Response

Successful response

exposes_capsulesinteger
reusedboolean required
share_urlstring uri required
tokenstring required

Share-link token

Changes

  • 3a2c4ebeab51Revision changes
    • info

      added the optional property / to the response with the status

  • c7729725d527Revision changes
    • info

      added the new optional request property

    • info

      added the new project enum value to the request property

    • 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 required property to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property to the response with the status