pub.chive.annotation.listForPage

chive.pub

Documentation

List annotations for a specific page in an eprint

main query

List annotations for a specific page in an eprint

Parameters

eprintUri string at-uri Required

AT-URI of the eprint

pageNumber integer Required

Page number to list annotations for

Output

Encodingapplication/json
annotations array Required

Annotations on the specified page

entityLinks array Optional

Entity links on the specified page

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 eprint
Include entity link annotations in response
Page number to list annotations for
View raw schema 
{
  "type": "query",
  "errors": [],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "annotations"
      ],
      "properties": {
        "annotations": {
          "type": "array",
          "items": {
            "ref": "pub.chive.annotation.listForEprint#annotationView",
            "type": "ref"
          },
          "description": "Annotations on the specified page"
        },
        "entityLinks": {
          "type": "array",
          "items": {
            "ref": "pub.chive.annotation.listForEprint#entityLinkView",
            "type": "ref"
          },
          "description": "Entity links on the specified page"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "eprintUri",
      "pageNumber"
    ],
    "properties": {
      "eprintUri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the eprint"
      },
      "pageNumber": {
        "type": "integer",
        "minimum": 1,
        "description": "Page number to list annotations for"
      },
      "includeEntityLinks": {
        "type": "boolean",
        "default": true,
        "description": "Include entity link annotations in response"
      }
    }
  },
  "description": "List annotations for a specific page in an eprint"
}

Lexicon Garden

@