SYsymbol-chat
capsule

Check whether a capsule alias is free in a Type before you create the capsule

Changed on
get/api/preview/capsules/alias-availability

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

Query parameters

type_idstring required

The Type the capsule is created in.

aliasstring required

The alias to check, trimmed by the server. A malformed alias is answered with available: false and its format reason.

Response

Successful response

availableboolean required
messagestring

A sentence to show beside the alias.

reasonstring

Why the alias is unavailable: a format reason from the alias grammar, or taken_live, taken_tombstone or taken_deleted.

reclaimableboolean

True when the alias belonged to a deleted capsule and a create with reclaim_alias: true reuses it.

Changes