pub.chive.eprint.listRelatedWorks

chive.pub

Documentation

List user-curated related works for an eprint

main query

List user-curated related works for an eprint

Parameters

cursor string Optional

Pagination cursor

eprintUri string at-uri Required

AT-URI of the eprint to list related works for

limit integer Optional

Maximum number of related works to return

Output

Encodingapplication/json
cursor string Optional

Pagination cursor for next page

relatedWorks array Required

No description available.

total integer Optional

Total number of related works

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 list related works for
Maximum number of related works to return
View raw schema 
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "relatedWorks"
      ],
      "properties": {
        "total": {
          "type": "integer",
          "description": "Total number of related works"
        },
        "cursor": {
          "type": "string",
          "description": "Pagination cursor for next page"
        },
        "relatedWorks": {
          "type": "array",
          "items": {
            "ref": "#relatedWorkView",
            "type": "ref"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "eprintUri"
    ],
    "properties": {
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "description": "Maximum number of related works to return"
      },
      "cursor": {
        "type": "string",
        "description": "Pagination cursor"
      },
      "eprintUri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the eprint to list related works for"
      }
    }
  },
  "description": "List user-curated related works for an eprint"
}
relatedWorkView object

No description available.

Properties

createdAt string datetime Required

When this related work link was created

curatorDid string did Required

DID of the user who created this link

description string Optional

Description of the relationship

relationType string Required

Type of relationship

sourceEprintUri string at-uri Required

AT-URI of the source eprint

targetEprintUri string at-uri Required

AT-URI of the related eprint

targetTitle string Optional

Title of the related eprint (resolved from index)

uri string at-uri Required

AT-URI of the related work record

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "sourceEprintUri",
    "targetEprintUri",
    "relationType",
    "curatorDid",
    "createdAt"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the related work record"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "When this related work link was created"
    },
    "curatorDid": {
      "type": "string",
      "format": "did",
      "description": "DID of the user who created this link"
    },
    "description": {
      "type": "string",
      "description": "Description of the relationship"
    },
    "targetTitle": {
      "type": "string",
      "description": "Title of the related eprint (resolved from index)"
    },
    "relationType": {
      "type": "string",
      "description": "Type of relationship"
    },
    "sourceEprintUri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the source eprint"
    },
    "targetEprintUri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the related eprint"
    }
  }
}

Lexicon Garden

@