buzz.bookhive.addToList Documentation (EN)

main procedure

Add a book to a list.

Input

Encodingapplication/json

description string Optional

Optional note about this book in the list

maxLength: 5000 bytes

hiveId string Required

Hive ID of the book to add

listUri string Required

AT-URI of the list

position integer Optional

Position in the list (for ordered lists)

Output

Encodingapplication/json

cid string Required

No description available.

uri string Required

No description available.

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://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "listUri",
        "hiveId"
      ],
      "properties": {
        "hiveId": {
          "type": "string",
          "description": "Hive ID of the book to add"
        },
        "listUri": {
          "type": "string",
          "description": "AT-URI of the list"
        },
        "position": {
          "type": "integer",
          "description": "Position in the list (for ordered lists)"
        },
        "description": {
          "type": "string",
          "maxLength": 5000,
          "description": "Optional note about this book in the list"
        }
      }
    },
    "encoding": "application/json"
  },
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "uri",
        "cid"
      ],
      "properties": {
        "cid": {
          "type": "string"
        },
        "uri": {
          "type": "string"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Add a book to a list."
}