SYsymbol-chat
share

List the share links to one capsule, Type or Collection

Changed on
get/api/preview/share

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

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

The kind of resource whose links to list.

resourceIdstring required

The capsule, Type or Collection id.

Response

Successful response

created_atstring required
expires_atstring nullable
idstring required

UUID v4 string

is_activeboolean required
is_liveboolean required
listingboolean required
max_viewsinteger nullable
permissionstring required
primaryboolean required
resource_idstring required

UUID v4 string

resource_pathstring nullable
resource_titlestring nullable
resource_type'capsule' | 'type' | 'collection' | 'project' required
revoked_atstring nullable
share_urlstring uri nullable required
share_url_unavailable_reason'listing' | 'withheld' | 'legacy' | 'unreadable' nullable
state'active' | 'expired' | 'exhausted' | 'suspended' | 'revoked' required
token_previewstring required
view_countinteger required

Changes

  • 3a2c4ebeab51Revision changes
    • info

      added the optional property / to the response with the status

  • c7729725d527Revision changes
    • breaking

      added the new required query request parameter resourceId

    • breaking

      added the new required query request parameter resourceType

    • 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