pub.chive.review.listForEprint

chive.pub

Documentation

List reviews for a specific eprint with optional filtering

main query

List reviews for a specific eprint with optional filtering

Parameters

cursor string Optional

Pagination cursor for next page

eprintUri string at-uri Required

AT-URI of the eprint

inlineOnly boolean Optional

Only include inline annotations with text span targets

limit integer Optional

Maximum number of results to return

motivation string Optional

Filter by W3C Web Annotation motivation

Output

Encodingapplication/json
cursor string Optional

Cursor for next page

hasMore boolean Required

Whether more results are available

reviews array Required

List of reviews for the eprint

total integer Optional

Total number of reviews for this eprint

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
Pagination cursor for next page
AT-URI of the eprint
Only include inline annotations with text span targets
Maximum number of results to return
Filter by W3C Web Annotation motivation
View raw schema 
{
  "type": "query",
  "errors": [],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "reviews",
        "hasMore"
      ],
      "properties": {
        "total": {
          "type": "integer",
          "description": "Total number of reviews for this eprint"
        },
        "cursor": {
          "type": "string",
          "description": "Cursor for next page"
        },
        "hasMore": {
          "type": "boolean",
          "description": "Whether more results are available"
        },
        "reviews": {
          "type": "array",
          "items": {
            "ref": "#reviewView",
            "type": "ref"
          },
          "description": "List of reviews for the eprint"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "eprintUri"
    ],
    "properties": {
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "description": "Maximum number of results to return"
      },
      "cursor": {
        "type": "string",
        "description": "Pagination cursor for next page"
      },
      "eprintUri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the eprint"
      },
      "inlineOnly": {
        "type": "boolean",
        "default": false,
        "description": "Only include inline annotations with text span targets"
      },
      "motivation": {
        "type": "string",
        "description": "Filter by W3C Web Annotation motivation",
        "knownValues": [
          "commenting",
          "highlighting",
          "questioning",
          "replying",
          "assessing",
          "bookmarking",
          "classifying",
          "describing",
          "editing",
          "linking",
          "moderating",
          "tagging"
        ]
      }
    }
  },
  "description": "List reviews for a specific eprint with optional filtering"
}
authorRef object

No description available.

Properties

avatar string uri Optional

A valid URI.

did string did Required

A decentralized identifier (DID).

displayName string Optional

No description available.

handle string Optional

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "avatar": {
      "type": "string",
      "format": "uri"
    },
    "handle": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    }
  }
}
reviewView object

View of a review/comment

Properties

author ref #authorRef Required

No description available.

body array of union Optional

Rich text body items

maxLength: 500 items
Known types:
bodyPlainText string Optional

Plain text body for search/preview

cid string Required

Content identifier

content string Required

Plain text content of the review

createdAt string datetime Required

When the review was created

deleted boolean Optional

Whether this review has been deleted (tombstone for thread preservation)

eprintUri string at-uri Required

AT-URI of the eprint being reviewed

indexedAt string datetime Required

When the review was indexed

motivation string Required

W3C Web Annotation motivation

Known values: commenting, highlighting, questioning, replying, assessing, bookmarking, classifying, describing, editing, linking, moderating, tagging
parentReviewUri string at-uri Optional

Parent review URI for threaded replies

replyCount integer Required

Number of direct replies

minimum: 0
target ref #textSpanTarget Optional

Target text span for inline annotations

uri string at-uri Required

Review AT-URI

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "author",
    "eprintUri",
    "content",
    "motivation",
    "replyCount",
    "createdAt",
    "indexedAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "description": "Content identifier"
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "Review AT-URI"
    },
    "body": {
      "type": "array",
      "items": {
        "refs": [
          "pub.chive.richtext.defs#textItem",
          "pub.chive.richtext.defs#nodeRefItem",
          "pub.chive.richtext.defs#wikidataRefItem",
          "pub.chive.richtext.defs#fieldRefItem",
          "pub.chive.richtext.defs#facetRefItem",
          "pub.chive.richtext.defs#eprintRefItem",
          "pub.chive.richtext.defs#annotationRefItem",
          "pub.chive.richtext.defs#authorRefItem",
          "pub.chive.richtext.defs#mentionItem",
          "pub.chive.richtext.defs#linkItem",
          "pub.chive.richtext.defs#tagItem",
          "pub.chive.richtext.defs#latexItem",
          "pub.chive.richtext.defs#codeBlockItem",
          "pub.chive.richtext.defs#headingItem",
          "pub.chive.richtext.defs#listItem",
          "pub.chive.richtext.defs#blockquoteItem"
        ],
        "type": "union"
      },
      "maxLength": 500,
      "description": "Rich text body items"
    },
    "author": {
      "ref": "#authorRef",
      "type": "ref"
    },
    "target": {
      "ref": "#textSpanTarget",
      "type": "ref",
      "description": "Target text span for inline annotations"
    },
    "content": {
      "type": "string",
      "description": "Plain text content of the review"
    },
    "deleted": {
      "type": "boolean",
      "default": false,
      "description": "Whether this review has been deleted (tombstone for thread preservation)"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the review was created"
    },
    "eprintUri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the eprint being reviewed"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the review was indexed"
    },
    "motivation": {
      "type": "string",
      "description": "W3C Web Annotation motivation",
      "knownValues": [
        "commenting",
        "highlighting",
        "questioning",
        "replying",
        "assessing",
        "bookmarking",
        "classifying",
        "describing",
        "editing",
        "linking",
        "moderating",
        "tagging"
      ]
    },
    "replyCount": {
      "type": "integer",
      "minimum": 0,
      "description": "Number of direct replies"
    },
    "bodyPlainText": {
      "type": "string",
      "description": "Plain text body for search/preview"
    },
    "parentReviewUri": {
      "type": "string",
      "format": "at-uri",
      "description": "Parent review URI for threaded replies"
    }
  },
  "description": "View of a review/comment"
}
textPositionSelector object

W3C Text Position Selector with optional page info

Properties

end integer Required

No description available.

minimum: 0
pageNumber integer Optional

Page number in PDF

minimum: 1
start integer Required

No description available.

minimum: 0
type string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "start",
    "end"
  ],
  "properties": {
    "end": {
      "type": "integer",
      "minimum": 0
    },
    "type": {
      "type": "string",
      "const": "TextPositionSelector"
    },
    "start": {
      "type": "integer",
      "minimum": 0
    },
    "pageNumber": {
      "type": "integer",
      "minimum": 1,
      "description": "Page number in PDF"
    }
  },
  "description": "W3C Text Position Selector with optional page info"
}
textQuoteSelector object

W3C Text Quote Selector

Properties

exact string Required

No description available.

maxLength: 1000 bytes
prefix string Optional

No description available.

maxLength: 100 bytes
suffix string Optional

No description available.

maxLength: 100 bytes
type string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "exact"
  ],
  "properties": {
    "type": {
      "type": "string",
      "const": "TextQuoteSelector"
    },
    "exact": {
      "type": "string",
      "maxLength": 1000
    },
    "prefix": {
      "type": "string",
      "maxLength": 100
    },
    "suffix": {
      "type": "string",
      "maxLength": 100
    }
  },
  "description": "W3C Text Quote Selector"
}
textSpanTarget object

Target text span for inline annotations (W3C Web Annotation compatible)

Properties

page integer Optional

Page number (deprecated, use refinedBy.pageNumber)

minimum: 1
source string at-uri Required

Eprint AT-URI

View raw schema 
{
  "type": "object",
  "required": [
    "source"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1,
      "description": "Page number (deprecated, use refinedBy.pageNumber)"
    },
    "source": {
      "type": "string",
      "format": "at-uri",
      "description": "Eprint AT-URI"
    },
    "selector": {
      "ref": "#textQuoteSelector",
      "type": "ref",
      "description": "Text quote selector"
    },
    "refinedBy": {
      "ref": "#textPositionSelector",
      "type": "ref",
      "description": "Position refinement with page info"
    }
  },
  "description": "Target text span for inline annotations (W3C Web Annotation compatible)"
}

Lexicon Garden

@