wiki.lichen.getWiki Documentation (EN)

main query

Get a wiki. Pass viewer to also get what that DID can do with it. Public wikis only. Takes a DID, so resolve a handle to one first with com.atproto.identity.resolveHandle.

Parameters

did string did Optional

Owner of the wiki. Use with slug.

slug string record-key Optional

The wiki's slug, which is also its record key. Use with did.

uri string at-uri Optional

AT-URI of the wiki record. Supply this, or did and slug.

viewer string did Optional

Ask what this DID can do with the wiki. Check it before writing, because ingest keeps a revision only from a DID that can edit and drops the rest silently.

Output

Encodingapplication/json

createdAt stringdatetime Required

The wiki record's own timestamp, in UTC. An unreadable or future-dated stamp falls back to our ingest time.

description string Required

No description available.

did stringdid Required

A decentralized identifier (DID).

homeSlug string Optional

The note shown as the wiki's front page, as the wiki record's homeSlug names it.

language string Required

No description available.

name string Required

No description available.

noteCount integer Required

How many notes listNotes returns. A note counts once its first revision is ingested.

slug string Required

No description available.

updatedAt stringdatetime Required

When this appview last saw the wiki or a note in it change. Observed locally, so appviews may legitimately disagree.

uri stringat-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

viewer ref#viewerState Optional

Present only when the viewer parameter was supplied.

Errors

NotFound

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)

Parameters

did Owner of the wiki. Use with slug.

slug The wiki's slug, which is also its record key. Use with did.

uri AT-URI of the wiki record. Supply this, or did and slug.

viewer Ask what this DID can do with the wiki. Check it before writing, because ingest keeps a revision only from a DID that can edit and drops the rest silently.

View raw schema

{
  "description": "Get a wiki. Pass viewer to also get what that DID can do with it. Public wikis only. Takes a DID, so resolve a handle to one first with com.atproto.identity.resolveHandle.",
  "errors": [
    {
      "name": "NotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "createdAt": {
          "description": "The wiki record's own timestamp, in UTC. An unreadable or future-dated stamp falls back to our ingest time.",
          "format": "datetime",
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "did": {
          "format": "did",
          "type": "string"
        },
        "homeSlug": {
          "description": "The note shown as the wiki's front page, as the wiki record's homeSlug names it.",
          "type": "string"
        },
        "language": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "noteCount": {
          "description": "How many notes listNotes returns. A note counts once its first revision is ingested.",
          "type": "integer"
        },
        "slug": {
          "type": "string"
        },
        "updatedAt": {
          "description": "When this appview last saw the wiki or a note in it change. Observed locally, so appviews may legitimately disagree.",
          "format": "datetime",
          "type": "string"
        },
        "uri": {
          "format": "at-uri",
          "type": "string"
        },
        "viewer": {
          "description": "Present only when the viewer parameter was supplied.",
          "ref": "#viewerState",
          "type": "ref"
        }
      },
      "required": [
        "uri",
        "did",
        "slug",
        "name",
        "description",
        "language",
        "noteCount",
        "createdAt",
        "updatedAt"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "did": {
        "description": "Owner of the wiki. Use with slug.",
        "format": "did",
        "type": "string"
      },
      "slug": {
        "description": "The wiki's slug, which is also its record key. Use with did.",
        "format": "record-key",
        "maxLength": 512,
        "type": "string"
      },
      "uri": {
        "description": "AT-URI of the wiki record. Supply this, or did and slug.",
        "format": "at-uri",
        "type": "string"
      },
      "viewer": {
        "description": "Ask what this DID can do with the wiki. Check it before writing, because ingest keeps a revision only from a DID that can edit and drops the rest silently.",
        "format": "did",
        "type": "string"
      }
    },
    "type": "params"
  },
  "type": "query"
}

viewerState object

No description available.

Properties

canWrite boolean Required

Whether a wiki.lichen.noteRevision written by this DID would be accepted.

did string did Required

A decentralized identifier (DID).

role string Optional

Present when the DID owns the wiki or holds a membership.

Known values: owner, admin, contributor, viewer

View raw schema

{
  "properties": {
    "canWrite": {
      "description": "Whether a wiki.lichen.noteRevision written by this DID would be accepted.",
      "type": "boolean"
    },
    "did": {
      "format": "did",
      "type": "string"
    },
    "role": {
      "description": "Present when the DID owns the wiki or holds a membership.",
      "knownValues": [
        "owner",
        "admin",
        "contributor",
        "viewer"
      ],
      "type": "string"
    }
  },
  "required": [
    "did",
    "canWrite"
  ],
  "type": "object"
}