pub.chive.collection.getMarginAnnotations

chive.pub

Documentation

Get Margin annotations (at.margin.annotation, at.margin.highlight) targeting a Chive eprint

main query

Get Margin annotations (at.margin.annotation, at.margin.highlight) targeting a Chive eprint

Parameters

cursor string Optional

Pagination cursor

eprintUri string Required

AT-URI of the eprint to get annotations for

limit integer Optional

Maximum results to return

Output

Encodingapplication/json
annotations array Required

No description available.

cursor string Optional

No description available.

hasMore boolean Optional

No description available.

total integer Optional

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://api.bsky.social)
Parameters
Pagination cursor
AT-URI of the eprint to get annotations for
Maximum results to return
View raw schema 
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "annotations"
      ],
      "properties": {
        "total": {
          "type": "integer"
        },
        "cursor": {
          "type": "string"
        },
        "hasMore": {
          "type": "boolean"
        },
        "annotations": {
          "type": "array",
          "items": {
            "ref": "#annotationView",
            "type": "ref"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "eprintUri"
    ],
    "properties": {
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "description": "Maximum results to return"
      },
      "cursor": {
        "type": "string",
        "description": "Pagination cursor"
      },
      "eprintUri": {
        "type": "string",
        "description": "AT-URI of the eprint to get annotations for"
      }
    }
  },
  "description": "Get Margin annotations (at.margin.annotation, at.margin.highlight) targeting a Chive eprint"
}
annotationView object

No description available.

Properties

authorDid string Required

DID of the annotation author

body string Optional

Annotation body text

bodyFormat string Optional

Body MIME type

color string Optional

Highlight color

createdAt string datetime Required

An RFC 3339 formatted timestamp.

motivation string Optional

W3C annotation motivation

pageTitle string Optional

Page title at annotation time

recordType string Required

Record type: annotation or highlight

tags array of string Optional

No description available.

uri string Required

AT-URI of the annotation record

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "authorDid",
    "recordType",
    "createdAt"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "description": "AT-URI of the annotation record"
    },
    "body": {
      "type": "string",
      "description": "Annotation body text"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "color": {
      "type": "string",
      "description": "Highlight color"
    },
    "authorDid": {
      "type": "string",
      "description": "DID of the annotation author"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "pageTitle": {
      "type": "string",
      "description": "Page title at annotation time"
    },
    "bodyFormat": {
      "type": "string",
      "description": "Body MIME type"
    },
    "motivation": {
      "type": "string",
      "description": "W3C annotation motivation"
    },
    "recordType": {
      "type": "string",
      "description": "Record type: annotation or highlight"
    }
  }
}

Lexicon Garden

@