social.colibri.beta.server.describeServer Documentation (EN)

main query

Gets information about this AppView.

Output

Encodingapplication/json

contact string Optional

How to reach the operator.

did stringdid Required

The AppView's own identity.

features array Optional

Optional features this AppView supports.

flavor string Required

Which build of the software this is. 'vanilla' for the stock AppView, and any string a fork or a customised deployment chooses for itself.

handleDomain string Required

The domain community handles are minted under.

pds stringuri Required

The PDS communities are created on.

software string Required

Stable software identifier, always 'colibri-appview'. Clients key on this to confirm a host is a Colibri AppView before pointing themselves at it.

spaceTypes array Optional

The space types this AppView understands.

version string Required

The running software version.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

View raw schema

{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "did",
        "software",
        "flavor",
        "version",
        "handleDomain",
        "pds"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did",
          "description": "The AppView's own identity."
        },
        "pds": {
          "type": "string",
          "format": "uri",
          "description": "The PDS communities are created on."
        },
        "flavor": {
          "type": "string",
          "description": "Which build of the software this is. 'vanilla' for the stock AppView, and any string a fork or a customised deployment chooses for itself."
        },
        "contact": {
          "type": "string",
          "description": "How to reach the operator."
        },
        "version": {
          "type": "string",
          "description": "The running software version."
        },
        "features": {
          "type": "array",
          "items": {
            "type": "string",
            "description": "A feature identifier.",
            "knownValues": [
              "voice",
              "push",
              "gifs",
              "embeds"
            ]
          },
          "description": "Optional features this AppView supports."
        },
        "software": {
          "type": "string",
          "description": "Stable software identifier, always 'colibri-appview'. Clients key on this to confirm a host is a Colibri AppView before pointing themselves at it."
        },
        "spaceTypes": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "nsid",
            "description": "A space type."
          },
          "description": "The space types this AppView understands."
        },
        "handleDomain": {
          "type": "string",
          "description": "The domain community handles are minted under."
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Gets information about this AppView."
}