ink.branchline.getBud

branchline.ink

Documentation

Get the full root-to-bud path that leads to a given bud, with pollen counts. Buds are returned in story order, oldest (root) to newest (bud), and the response is paginated. The cursor is the AT-URI of the next bud to return on the following page; it is omitted when the target bud has been reached.

main query

Get the full root-to-bud path that leads to a given bud, with pollen counts. Buds are returned in story order, oldest (root) to newest (bud), and the response is paginated. The cursor is the AT-URI of the next bud to return on the following page; it is omitted when the target bud has been reached.

Parameters

bud string at-uri Required

AT-URI of the bud at the end of this path.

cursor string at-uri Optional

AT-URI of the bud to start the next page at. Omit on the first request.

limit integer Optional

No description available.

Output

Encodingapplication/json
bud stringat-uri Required

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

buds array Required

No description available.

cursor stringat-uri Optional

AT-URI of the next bud to fetch. Absent when the target bud has been returned.

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
AT-URI of the bud at the end of this path.
AT-URI of the bud to start the next page at. Omit on the first request.
View raw schema
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "bud",
        "buds"
      ],
      "properties": {
        "bud": {
          "type": "string",
          "format": "at-uri"
        },
        "buds": {
          "type": "array",
          "items": {
            "ref": "#budView",
            "type": "ref"
          }
        },
        "cursor": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the next bud to fetch. Absent when the target bud has been returned."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "bud"
    ],
    "properties": {
      "bud": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the bud at the end of this path."
      },
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1
      },
      "cursor": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the bud to start the next page at. Omit on the first request."
      }
    }
  },
  "description": "Get the full root-to-bud path that leads to a given bud, with pollen counts. Buds are returned in story order, oldest (root) to newest (bud), and the response is paginated. The cursor is the AT-URI of the next bud to return on the following page; it is omitted when the target bud has been reached."
}
budView object

No description available.

Properties

author string did Required

A decentralized identifier (DID).

cid string cid Required

A content identifier (CID) referencing immutable data.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

depth integer Required

Depth of this bud in the story tree (0 = root).

minimum: 0
pollenCount integer Required

Lifetime number of pollen grains on this bud (raw count, not the ranking-weighted score).

minimum: 0
text string Required

No description available.

title string Required

No description available.

uri string at-uri Required

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

View raw schema
{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "author",
    "title",
    "text",
    "createdAt",
    "depth",
    "pollenCount"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "text": {
      "type": "string"
    },
    "depth": {
      "type": "integer",
      "minimum": 0,
      "description": "Depth of this bud in the story tree (0 = root)."
    },
    "title": {
      "type": "string"
    },
    "author": {
      "type": "string",
      "format": "did"
    },
    "parent": {
      "ref": "com.atproto.repo.strongRef",
      "type": "ref"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "formatting": {
      "type": "array",
      "items": {
        "ref": "ink.branchline.bud#formatSpan",
        "type": "ref"
      }
    },
    "pollenCount": {
      "type": "integer",
      "minimum": 0,
      "description": "Lifetime number of pollen grains on this bud (raw count, not the ranking-weighted score)."
    }
  }
}

Lexicon Garden

@