pub.chive.annotation.listForPage Documentation (EN)

main query

List annotations for a specific page in an eprint

Parameters

eprintUri string at-uri Required

AT-URI of the eprint

includeEntityLinks boolean Optional

Include entity link annotations in response

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.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

eprintUri * AT-URI of the eprint

includeEntityLinks Include entity link annotations in response

pageNumber * Page number to list annotations for

View raw schema

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