ink.branchline.editBud

branchline.ink

Documentation

Edit the title, text, and/or inline formatting of an existing bud. The caller must be signed in and must be the bud's author. The bud must have no children and must not be locked — edits to a bud with descendants would reshape text that later writers have already continued from, and locked buds are frozen by an admin. The AppView overwrites the ink.branchline.bud record in the caller's PDS via putRecord and mirrors the new row into the local read cache. `createdAt` and `bloomsAt` are preserved; the PDS assigns a new CID.

main procedure

Edit the title, text, and/or inline formatting of an existing bud. The caller must be signed in and must be the bud's author. The bud must have no children and must not be locked — edits to a bud with descendants would reshape text that later writers have already continued from, and locked buds are frozen by an admin. The AppView overwrites the ink.branchline.bud record in the caller's PDS via putRecord and mirrors the new row into the local read cache. `createdAt` and `bloomsAt` are preserved; the PDS assigns a new CID.

Input

Encodingapplication/json
formatting array Optional

Byte-offset inline formatting spans over `text`. Replaces any prior spans on the bud.

text string Required

No description available.

maxLength: 20000 bytes
title string Required

No description available.

maxLength: 1200 bytesmaxGraphemes: 120 graphemes
uri stringat-uri Required

AT-URI of the bud to edit.

Output

Encodingapplication/json
cid stringcid Required

The new CID assigned by the PDS after the record is overwritten.

uri stringat-uri Required

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

Errors

Unauthorized The caller is not signed in.
BudNotFound No bud exists at the given URI in the AppView.
NotOwner The caller is not the bud's author.
BudHasChildren The bud has one or more continuations and can no longer be edited.
BudLocked The bud has been locked by an admin and can no longer be edited.
WordLimitExceeded The edited bud text exceeds the 500-word ceiling.
InvalidFormatting A formatting span is malformed — offsets out of bounds, start >= end, or an unknown span type.
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://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "uri",
        "title",
        "text"
      ],
      "properties": {
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the bud to edit."
        },
        "text": {
          "type": "string",
          "maxLength": 20000
        },
        "title": {
          "type": "string",
          "maxLength": 1200,
          "maxGraphemes": 120
        },
        "formatting": {
          "type": "array",
          "items": {
            "ref": "ink.branchline.bud#formatSpan",
            "type": "ref"
          },
          "description": "Byte-offset inline formatting spans over `text`. Replaces any prior spans on the bud."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "Unauthorized",
      "description": "The caller is not signed in."
    },
    {
      "name": "BudNotFound",
      "description": "No bud exists at the given URI in the AppView."
    },
    {
      "name": "NotOwner",
      "description": "The caller is not the bud's author."
    },
    {
      "name": "BudHasChildren",
      "description": "The bud has one or more continuations and can no longer be edited."
    },
    {
      "name": "BudLocked",
      "description": "The bud has been locked by an admin and can no longer be edited."
    },
    {
      "name": "WordLimitExceeded",
      "description": "The edited bud text exceeds the 500-word ceiling."
    },
    {
      "name": "InvalidFormatting",
      "description": "A formatting span is malformed — offsets out of bounds, start >= end, or an unknown span type."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "uri",
        "cid"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid",
          "description": "The new CID assigned by the PDS after the record is overwritten."
        },
        "uri": {
          "type": "string",
          "format": "at-uri"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Edit the title, text, and/or inline formatting of an existing bud. The caller must be signed in and must be the bud's author. The bud must have no children and must not be locked — edits to a bud with descendants would reshape text that later writers have already continued from, and locked buds are frozen by an admin. The AppView overwrites the ink.branchline.bud record in the caller's PDS via putRecord and mirrors the new row into the local read cache. `createdAt` and `bloomsAt` are preserved; the PDS assigns a new CID."
}

Lexicon Garden

@