wiki.lichen.getNote

lichen.wiki

Documentation

Get a note's current content and the head revision to write against. Public wikis only.

main query

Get a note's current content and the head revision to write against. Public wikis only.

Parameters

slug string Optional

The note's slug, unique within its wiki. Use with wiki.

uri string at-uri Optional

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

wiki string at-uri Optional

AT-URI of the wiki the note belongs to. Use with slug.

Output

Encodingapplication/json
content string Required

The note's body as its last revision left it, byte for byte. Frontmatter and wikilinks stay exactly as the author wrote them. Writing this text back unchanged produces an empty revision.

createdAt stringdatetime Required

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

did stringdid Required

The DID that created the note record. Later revisions can come from anyone allowed to edit the wiki.

latestRevisionUri stringat-uri Required

The head revision. Set it as parentRevision on your noteRevision to write against this content. Only a revision parented here moves the note.

slug string Required

No description available.

title string Required

No description available.

updatedAt stringdatetime Required

The head revision's own timestamp, so appviews holding the same history agree. Same fallback as createdAt.

uri stringat-uri Required

AT-URI of the note record. The rkey is a TID, so read it from here or address the note by wiki and slug.

wiki stringat-uri Required

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

Errors

NotFound
Try It

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

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
The note's slug, unique within its wiki. Use with wiki.
AT-URI of the note record. Supply this, or wiki and slug.
AT-URI of the wiki the note belongs to. Use with slug.
View raw schema 
{
  "description": "Get a note's current content and the head revision to write against. Public wikis only.",
  "errors": [
    {
      "name": "NotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "content": {
          "description": "The note's body as its last revision left it, byte for byte. Frontmatter and wikilinks stay exactly as the author wrote them. Writing this text back unchanged produces an empty revision.",
          "type": "string"
        },
        "createdAt": {
          "description": "The note record's own timestamp, in UTC. An unreadable or future-dated stamp falls back to our ingest time.",
          "format": "datetime",
          "type": "string"
        },
        "did": {
          "description": "The DID that created the note record. Later revisions can come from anyone allowed to edit the wiki.",
          "format": "did",
          "type": "string"
        },
        "latestRevisionUri": {
          "description": "The head revision. Set it as parentRevision on your noteRevision to write against this content. Only a revision parented here moves the note.",
          "format": "at-uri",
          "type": "string"
        },
        "slug": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "updatedAt": {
          "description": "The head revision's own timestamp, so appviews holding the same history agree. Same fallback as createdAt.",
          "format": "datetime",
          "type": "string"
        },
        "uri": {
          "description": "AT-URI of the note record. The rkey is a TID, so read it from here or address the note by wiki and slug.",
          "format": "at-uri",
          "type": "string"
        },
        "wiki": {
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "uri",
        "wiki",
        "did",
        "slug",
        "title",
        "content",
        "latestRevisionUri",
        "createdAt",
        "updatedAt"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "slug": {
        "description": "The note's slug, unique within its wiki. Use with wiki.",
        "maxGraphemes": 256,
        "maxLength": 2560,
        "type": "string"
      },
      "uri": {
        "description": "AT-URI of the note record. Supply this, or wiki and slug.",
        "format": "at-uri",
        "type": "string"
      },
      "wiki": {
        "description": "AT-URI of the wiki the note belongs to. Use with slug.",
        "format": "at-uri",
        "type": "string"
      }
    },
    "type": "params"
  },
  "type": "query"
}

Lexicon Garden

@