pub.chive.import.get

chive.pub

Documentation

Get an imported eprint by source and external ID

main query

Get an imported eprint by source and external ID

Parameters

externalId string Required

Source-specific identifier for the eprint

source string Required

External source identifier (e.g., arxiv, biorxiv, semanticscholar)

Output

Encodingapplication/json
Schema#importedEprint

Errors

NotFound The imported eprint was not found
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
Source-specific identifier for the eprint
External source identifier (e.g., arxiv, biorxiv, semanticscholar)
View raw schema 
{
  "type": "query",
  "errors": [
    {
      "name": "NotFound",
      "description": "The imported eprint was not found"
    }
  ],
  "output": {
    "schema": {
      "ref": "#importedEprint",
      "type": "ref"
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "source",
      "externalId"
    ],
    "properties": {
      "source": {
        "type": "string",
        "maxLength": 50,
        "minLength": 2,
        "description": "External source identifier (e.g., arxiv, biorxiv, semanticscholar)"
      },
      "externalId": {
        "type": "string",
        "minLength": 1,
        "description": "Source-specific identifier for the eprint"
      }
    }
  },
  "description": "Get an imported eprint by source and external ID"
}
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

@