pub.chive.import.search

chive.pub

Documentation

Search imported eprints in the AppView cache

main query

Search imported eprints in the AppView cache

Parameters

authorName string Optional

Filter by author name

authorOrcid string Optional

Filter by author ORCID

claimStatus string Optional

Filter by claim status

cursor string Optional

Pagination cursor

limit integer Optional

Maximum results to return

query string Optional

Search query for title, abstract, or author

source string Optional

Filter by external source identifier

Output

Encodingapplication/json
cursor string Optional

Cursor for next page

eprints array Required

List of matching imported eprints

hasMore boolean Required

Whether more results are 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
Filter by author name
Filter by author ORCID
Filter by claim status
Pagination cursor
Maximum results to return
Search query for title, abstract, or author
Filter by external source identifier
View raw schema
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "eprints",
        "hasMore"
      ],
      "properties": {
        "cursor": {
          "type": "string",
          "description": "Cursor for next page"
        },
        "eprints": {
          "type": "array",
          "items": {
            "ref": "#importedEprint",
            "type": "ref"
          },
          "description": "List of matching imported eprints"
        },
        "hasMore": {
          "type": "boolean",
          "description": "Whether more results are available"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "description": "Maximum results to return"
      },
      "query": {
        "type": "string",
        "description": "Search query for title, abstract, or author"
      },
      "cursor": {
        "type": "string",
        "description": "Pagination cursor"
      },
      "source": {
        "type": "string",
        "maxLength": 50,
        "minLength": 2,
        "description": "Filter by external source identifier"
      },
      "authorName": {
        "type": "string",
        "description": "Filter by author name"
      },
      "authorOrcid": {
        "type": "string",
        "description": "Filter by author ORCID"
      },
      "claimStatus": {
        "type": "string",
        "description": "Filter by claim status",
        "knownValues": [
          "unclaimed",
          "pending",
          "claimed"
        ]
      }
    }
  },
  "description": "Search imported eprints in the AppView cache"
}
externalAuthor object

An author from an external source

Properties

affiliation string Optional

Institutional affiliation

email string Optional

Email address

name string Required

Author name

orcid string Optional

ORCID identifier

View raw schema
{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Author name"
    },
    "email": {
      "type": "string",
      "description": "Email address"
    },
    "orcid": {
      "type": "string",
      "description": "ORCID identifier"
    },
    "affiliation": {
      "type": "string",
      "description": "Institutional affiliation"
    }
  },
  "description": "An author from an external source"
}
importedEprint object

An eprint imported from an external source

Properties

abstract string Optional

Abstract text

canonicalUri string at-uri Optional

AT-URI of the canonical record if claimed

categories array of string Optional

Subject categories

claimStatus string Required

Current claim status

Known values: unclaimed, pending, claimed
claimedAt string datetime Optional

When the eprint was claimed

claimedByDid string did Optional

DID of the user who claimed this eprint

doi string Optional

DOI if assigned

externalId string Required

Source-specific identifier

id integer Required

Internal import ID

importedAt string datetime Required

When the eprint was imported

importedByPlugin string Required

Plugin that imported this eprint

lastSyncedAt string datetime Optional

When the eprint was last synced

pdfUrl string uri Optional

URL to PDF

publicationDate string datetime Optional

Publication date

source string Required

External source identifier

syncStatus string Required

Current sync status

Known values: active, stale, unavailable
title string Required

Eprint title

url string uri Required

URL to the eprint on the external source

View raw schema
{
  "type": "object",
  "required": [
    "id",
    "source",
    "externalId",
    "url",
    "title",
    "authors",
    "importedByPlugin",
    "importedAt",
    "syncStatus",
    "claimStatus"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "description": "Internal import ID"
    },
    "doi": {
      "type": "string",
      "description": "DOI if assigned"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "URL to the eprint on the external source"
    },
    "title": {
      "type": "string",
      "description": "Eprint title"
    },
    "pdfUrl": {
      "type": "string",
      "format": "uri",
      "description": "URL to PDF"
    },
    "source": {
      "type": "string",
      "description": "External source identifier"
    },
    "authors": {
      "type": "array",
      "items": {
        "ref": "#externalAuthor",
        "type": "ref"
      },
      "description": "Author list"
    },
    "abstract": {
      "type": "string",
      "description": "Abstract text"
    },
    "claimedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the eprint was claimed"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Subject categories"
    },
    "externalId": {
      "type": "string",
      "description": "Source-specific identifier"
    },
    "importedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the eprint was imported"
    },
    "syncStatus": {
      "type": "string",
      "description": "Current sync status",
      "knownValues": [
        "active",
        "stale",
        "unavailable"
      ]
    },
    "claimStatus": {
      "type": "string",
      "description": "Current claim status",
      "knownValues": [
        "unclaimed",
        "pending",
        "claimed"
      ]
    },
    "canonicalUri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the canonical record if claimed"
    },
    "claimedByDid": {
      "type": "string",
      "format": "did",
      "description": "DID of the user who claimed this eprint"
    },
    "lastSyncedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the eprint was last synced"
    },
    "publicationDate": {
      "type": "string",
      "format": "datetime",
      "description": "Publication date"
    },
    "importedByPlugin": {
      "type": "string",
      "description": "Plugin that imported this eprint"
    }
  },
  "description": "An eprint imported from an external source"
}

Lexicon Garden

@