pub.chive.graph.browseFaceted

chive.pub

Documentation

Browse eprints using dynamic faceted classification from the knowledge graph

main query

Browse eprints using dynamic faceted classification from the knowledge graph

Parameters

cursor string Optional

Pagination cursor

facets string Optional

JSON-encoded facet filters keyed by facet slug (e.g., {"methodology":["meta-analysis"]})

limit integer Optional

Maximum results to return

q string Optional

Optional text query

Output

Encodingapplication/json
cursor string Optional

Pagination cursor for next page

facets array Required

Available facet refinements

hasMore boolean Required

Whether more results exist

hits array Required

Matching eprints

impressionId string Optional

Impression ID for click tracking

total integer Required

Total count of matching eprints

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
JSON-encoded facet filters keyed by facet slug (e.g., {"methodology":["meta-analysis"]})
Maximum results to return
Optional text query
View raw schema 
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "hits",
        "facets",
        "hasMore",
        "total"
      ],
      "properties": {
        "hits": {
          "type": "array",
          "items": {
            "ref": "#eprintSummary",
            "type": "ref"
          },
          "description": "Matching eprints"
        },
        "total": {
          "type": "integer",
          "description": "Total count of matching eprints"
        },
        "cursor": {
          "type": "string",
          "description": "Pagination cursor for next page"
        },
        "facets": {
          "type": "array",
          "items": {
            "ref": "#facetDefinition",
            "type": "ref"
          },
          "description": "Available facet refinements"
        },
        "hasMore": {
          "type": "boolean",
          "description": "Whether more results exist"
        },
        "impressionId": {
          "type": "string",
          "description": "Impression ID for click tracking"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "q": {
        "type": "string",
        "description": "Optional text query"
      },
      "limit": {
        "type": "integer",
        "default": 20,
        "maximum": 100,
        "minimum": 1,
        "description": "Maximum results to return"
      },
      "cursor": {
        "type": "string",
        "description": "Pagination cursor"
      },
      "facets": {
        "type": "string",
        "description": "JSON-encoded facet filters keyed by facet slug (e.g., {\"methodology\":[\"meta-analysis\"]})"
      }
    }
  },
  "description": "Browse eprints using dynamic faceted classification from the knowledge graph"
}
authorRef object

Author reference with contributions

Properties

avatarUrl string Optional

Avatar image URL

did string did Optional

Author DID

email string Optional

Contact email

handle string Optional

ATProto handle

isCorrespondingAuthor boolean Optional

Whether this is the corresponding author

isHighlighted boolean Optional

Whether this author should be highlighted

name string Required

Display name

orcid string Optional

ORCID identifier

order integer Required

Author order (1-based)

View raw schema 
{
  "type": "object",
  "required": [
    "name",
    "order",
    "affiliations",
    "contributions"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "Author DID"
    },
    "name": {
      "type": "string",
      "description": "Display name"
    },
    "email": {
      "type": "string",
      "description": "Contact email"
    },
    "orcid": {
      "type": "string",
      "description": "ORCID identifier"
    },
    "order": {
      "type": "integer",
      "description": "Author order (1-based)"
    },
    "handle": {
      "type": "string",
      "description": "ATProto handle"
    },
    "avatarUrl": {
      "type": "string",
      "description": "Avatar image URL"
    },
    "affiliations": {
      "type": "array",
      "items": {
        "ref": "pub.chive.defs#affiliation",
        "type": "ref"
      },
      "description": "Author affiliations"
    },
    "contributions": {
      "type": "array",
      "items": {
        "ref": "#contributionRef",
        "type": "ref"
      },
      "description": "CRediT contributions"
    },
    "isHighlighted": {
      "type": "boolean",
      "description": "Whether this author should be highlighted"
    },
    "isCorrespondingAuthor": {
      "type": "boolean",
      "description": "Whether this is the corresponding author"
    }
  },
  "description": "Author reference with contributions"
}
contributionRef object

CRediT contribution

Properties

degree string Optional

Degree of contribution

Known values: lead, equal, supporting
typeId string Required

Contribution type identifier

typeLabel string Required

Contribution type label

typeUri string at-uri Required

AT-URI of contribution type node

View raw schema 
{
  "type": "object",
  "required": [
    "typeUri",
    "typeId",
    "typeLabel"
  ],
  "properties": {
    "degree": {
      "type": "string",
      "description": "Degree of contribution",
      "knownValues": [
        "lead",
        "equal",
        "supporting"
      ]
    },
    "typeId": {
      "type": "string",
      "description": "Contribution type identifier"
    },
    "typeUri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of contribution type node"
    },
    "typeLabel": {
      "type": "string",
      "description": "Contribution type label"
    }
  },
  "description": "CRediT contribution"
}
eprintSummary object

Eprint summary for faceted browse results

Properties

abstract array of union Required

Rich abstract with text, formatting, and entity references

maxLength: 500 items
Known types:
authors array of ref#authorRef Required

All authors with contributions

cid string Required

CID of indexed version

createdAt string datetime Required

Creation timestamp

fields array of ref#fieldRef Optional

Subject fields

highlights unknown Optional

Search highlights keyed by field

indexedAt string datetime Required

Index timestamp

keywords array of string Optional

Keywords

license string Required

License identifier

paperDid string did Optional

Paper DID if paper has its own PDS

score integer Optional

Relevance score (scaled by 1000 for 0.0-1.0 range)

minimum: 0maximum: 1000
source ref #sourceInfo Required

Source PDS information

submittedBy string did Required

DID of human user who submitted

title string Required

Eprint title

uri string at-uri Required

Eprint AT-URI

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "title",
    "abstract",
    "authors",
    "submittedBy",
    "license",
    "createdAt",
    "indexedAt",
    "source"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "description": "CID of indexed version"
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "Eprint AT-URI"
    },
    "score": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 0,
      "description": "Relevance score (scaled by 1000 for 0.0-1.0 range)"
    },
    "title": {
      "type": "string",
      "description": "Eprint title"
    },
    "fields": {
      "type": "array",
      "items": {
        "ref": "#fieldRef",
        "type": "ref"
      },
      "description": "Subject fields"
    },
    "source": {
      "ref": "#sourceInfo",
      "type": "ref",
      "description": "Source PDS information"
    },
    "authors": {
      "type": "array",
      "items": {
        "ref": "#authorRef",
        "type": "ref"
      },
      "description": "All authors with contributions"
    },
    "license": {
      "type": "string",
      "description": "License identifier"
    },
    "abstract": {
      "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 abstract with text, formatting, and entity references"
    },
    "keywords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Keywords"
    },
    "paperDid": {
      "type": "string",
      "format": "did",
      "description": "Paper DID if paper has its own PDS"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "Creation timestamp"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime",
      "description": "Index timestamp"
    },
    "highlights": {
      "type": "unknown",
      "description": "Search highlights keyed by field"
    },
    "submittedBy": {
      "type": "string",
      "format": "did",
      "description": "DID of human user who submitted"
    }
  },
  "description": "Eprint summary for faceted browse results"
}
facetDefinition object

Facet definition from the knowledge graph

Properties

description string Optional

Facet description

label string Required

Display label

slug string Required

Facet slug identifier

values array of ref#facetValue Required

Available values with counts

View raw schema 
{
  "type": "object",
  "required": [
    "slug",
    "label",
    "values"
  ],
  "properties": {
    "slug": {
      "type": "string",
      "description": "Facet slug identifier"
    },
    "label": {
      "type": "string",
      "description": "Display label"
    },
    "values": {
      "type": "array",
      "items": {
        "ref": "#facetValue",
        "type": "ref"
      },
      "description": "Available values with counts"
    },
    "description": {
      "type": "string",
      "description": "Facet description"
    }
  },
  "description": "Facet definition from the knowledge graph"
}
facetValue object

Facet value with count

Properties

count integer Required

Number of eprints with this value

label string Optional

Display label

value string Required

Facet value

View raw schema 
{
  "type": "object",
  "required": [
    "value",
    "count"
  ],
  "properties": {
    "count": {
      "type": "integer",
      "description": "Number of eprints with this value"
    },
    "label": {
      "type": "string",
      "description": "Display label"
    },
    "value": {
      "type": "string",
      "description": "Facet value"
    }
  },
  "description": "Facet value with count"
}
fieldRef object

Subject field reference

Properties

id string Optional

Field identifier

label string Required

Field label

parentUri string at-uri Optional

Parent field AT-URI

uri string at-uri Required

Field AT-URI

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "label"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Field identifier"
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "Field AT-URI"
    },
    "label": {
      "type": "string",
      "description": "Field label"
    },
    "parentUri": {
      "type": "string",
      "format": "at-uri",
      "description": "Parent field AT-URI"
    }
  },
  "description": "Subject field reference"
}
sourceInfo object

Source PDS information

Properties

blobUrl string Optional

Blob URL

lastVerifiedAt string datetime Optional

Last verification timestamp

pdsEndpoint string Required

PDS endpoint URL

recordUrl string Optional

Direct record URL

stale boolean Optional

Whether data is potentially stale

View raw schema 
{
  "type": "object",
  "required": [
    "pdsEndpoint"
  ],
  "properties": {
    "stale": {
      "type": "boolean",
      "description": "Whether data is potentially stale"
    },
    "blobUrl": {
      "type": "string",
      "description": "Blob URL"
    },
    "recordUrl": {
      "type": "string",
      "description": "Direct record URL"
    },
    "pdsEndpoint": {
      "type": "string",
      "description": "PDS endpoint URL"
    },
    "lastVerifiedAt": {
      "type": "string",
      "format": "datetime",
      "description": "Last verification timestamp"
    }
  },
  "description": "Source PDS information"
}

Lexicon Garden

@