pub.chive.resolve.byExternalId Documentation (EN)

main query

Resolve an external identifier (DOI, arXiv, ORCID, ROR, ISBN, etc.) to the Chive entity that declares it — either a Chive-native eprint submission or a knowledge-graph node.

Parameters

identifier string Required

Identifier value (without URL prefix).

system string Required

External identifier system.

Output

Encodingapplication/json

entityType string Optional

Kind of entity that matched.

Known values: eprint, author, graphNode

found boolean Required

Whether a matching entity was found.

label string Optional

Display label for the matched entity.

uri stringat-uri Optional

AT-URI of the matched entity.

webPath string Optional

Chive web path that renders this entity (e.g., /eprints/...).

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

identifier * Identifier value (without URL prefix).

system * External identifier system.

View raw schema

{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "found"
      ],
      "properties": {
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the matched entity."
        },
        "found": {
          "type": "boolean",
          "description": "Whether a matching entity was found."
        },
        "label": {
          "type": "string",
          "description": "Display label for the matched entity."
        },
        "webPath": {
          "type": "string",
          "description": "Chive web path that renders this entity (e.g., /eprints/...)."
        },
        "entityType": {
          "type": "string",
          "description": "Kind of entity that matched.",
          "knownValues": [
            "eprint",
            "author",
            "graphNode"
          ]
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "system",
      "identifier"
    ],
    "properties": {
      "system": {
        "type": "string",
        "description": "External identifier system.",
        "knownValues": [
          "doi",
          "arxiv",
          "orcid",
          "ror",
          "isbn",
          "pmid",
          "wikidata"
        ]
      },
      "identifier": {
        "type": "string",
        "description": "Identifier value (without URL prefix)."
      }
    }
  },
  "description": "Resolve an external identifier (DOI, arXiv, ORCID, ROR, ISBN, etc.) to the Chive entity that declares it — either a Chive-native eprint submission or a knowledge-graph node."
}