pub.chive.claiming.getSuggestions

lexicons.governance.chive.pub

Documentation

Get suggested papers for the authenticated user to claim based on their profile

main query

Get suggested papers for the authenticated user to claim based on their profile

Parameters

limit integer Optional

Maximum number of suggestions to return

Output

Encodingapplication/json
papers array Required

Suggested papers sorted by match score

Errors

AuthenticationRequired
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
Maximum number of suggestions to return
View raw schema 
{
  "description": "Get suggested papers for the authenticated user to claim based on their profile",
  "errors": [
    {
      "name": "AuthenticationRequired"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "papers": {
          "description": "Suggested papers sorted by match score",
          "items": {
            "ref": "#suggestedPaper",
            "type": "ref"
          },
          "type": "array"
        },
        "profileUsed": {
          "ref": "#profileMetadata",
          "type": "ref"
        }
      },
      "required": [
        "papers",
        "profileUsed"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "limit": {
        "default": 20,
        "description": "Maximum number of suggestions to return",
        "maximum": 50,
        "minimum": 1,
        "type": "integer"
      }
    },
    "type": "params"
  },
  "type": "query"
}
externalAuthor object

No description available.

Properties

affiliation string Optional

Institution affiliation

email string Optional

Email address

name string Required

Author name

orcid string Optional

ORCID identifier

View raw schema 
{
  "properties": {
    "affiliation": {
      "description": "Institution affiliation",
      "type": "string"
    },
    "email": {
      "description": "Email address",
      "type": "string"
    },
    "name": {
      "description": "Author name",
      "type": "string"
    },
    "orcid": {
      "description": "ORCID identifier",
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}
profileMetadata object

Profile data used for matching

Properties

displayName string Optional

User display name

hasExternalIds boolean Required

Whether user has external authority IDs

hasOrcid boolean Required

Whether user has ORCID linked

nameVariants array of string Required

Name variants used for matching

View raw schema 
{
  "description": "Profile data used for matching",
  "properties": {
    "displayName": {
      "description": "User display name",
      "type": "string"
    },
    "hasExternalIds": {
      "description": "Whether user has external authority IDs",
      "type": "boolean"
    },
    "hasOrcid": {
      "description": "Whether user has ORCID linked",
      "type": "boolean"
    },
    "nameVariants": {
      "description": "Name variants used for matching",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "nameVariants",
    "hasOrcid",
    "hasExternalIds"
  ],
  "type": "object"
}
suggestedPaper object

No description available.

Properties

abstract string Optional

Abstract text

categories array of string Optional

Subject categories

chiveUri string Optional

AT-URI of the paper in Chive's index (present when source is 'chive')

doi string Optional

DOI if assigned

externalId string Required

Source-specific identifier

matchReason string Required

Human-readable match reason

matchScore integer Required

Match confidence score (0-100)

minimum: 0maximum: 100
pdfUrl string uri Optional

URL to PDF

publicationDate string datetime Optional

Publication date

source string Required

Source system

title string Required

Eprint title

url string uri Required

Full URL to the eprint

View raw schema 
{
  "properties": {
    "abstract": {
      "description": "Abstract text",
      "type": "string"
    },
    "authors": {
      "description": "Author list",
      "items": {
        "ref": "#externalAuthor",
        "type": "ref"
      },
      "type": "array"
    },
    "categories": {
      "description": "Subject categories",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "chiveUri": {
      "description": "AT-URI of the paper in Chive's index (present when source is 'chive')",
      "type": "string"
    },
    "doi": {
      "description": "DOI if assigned",
      "type": "string"
    },
    "externalId": {
      "description": "Source-specific identifier",
      "type": "string"
    },
    "matchReason": {
      "description": "Human-readable match reason",
      "type": "string"
    },
    "matchScore": {
      "description": "Match confidence score (0-100)",
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    },
    "pdfUrl": {
      "description": "URL to PDF",
      "format": "uri",
      "type": "string"
    },
    "publicationDate": {
      "description": "Publication date",
      "format": "datetime",
      "type": "string"
    },
    "source": {
      "description": "Source system",
      "type": "string"
    },
    "title": {
      "description": "Eprint title",
      "type": "string"
    },
    "url": {
      "description": "Full URL to the eprint",
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "externalId",
    "url",
    "title",
    "authors",
    "source",
    "matchScore",
    "matchReason"
  ],
  "type": "object"
}

Lexicon Garden

@