buzz.bookhive.createList

bookhive.buzz

Documentation

Create a new book list.

main procedure

Create a new book list.

Input

Encodingapplication/json
description string Optional

Optional description of the list

maxLength: 500 bytes
name string Required

The name of the list

maxLength: 100 bytesminLength: 1 bytes
ordered boolean Optional

Whether the list is ordered

tags array Optional

Optional tags

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.

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": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 100,
          "minLength": 1,
          "description": "The name of the list"
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 50
          },
          "description": "Optional tags"
        },
        "ordered": {
          "type": "boolean",
          "description": "Whether the list is ordered"
        },
        "description": {
          "type": "string",
          "maxLength": 500,
          "description": "Optional description of the list"
        }
      }
    },
    "encoding": "application/json"
  },
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "uri",
        "cid"
      ],
      "properties": {
        "cid": {
          "type": "string"
        },
        "uri": {
          "type": "string"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Create a new book list."
}

Lexicon Garden

@