pub.chive.claiming.getSubmissionData

chive.pub

Documentation

Get prefilled form data for claiming a paper from an external source

main query

Get prefilled form data for claiming a paper from an external source

Parameters

externalId string Required

Source-specific identifier

source string Required

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

Output

Encodingapplication/json
abstract string Required

Prefilled abstract

authors array Required

Prefilled authors

doi string Optional

DOI if available

externalId string Required

Source-specific external ID

externalIds ref#externalIds Optional

No description available.

externalUrl stringuri Required

External URL to the paper

keywords array Required

Prefilled keywords/categories

pdfUrl stringuri Optional

PDF URL if available

publicationDate stringdatetime Optional

Publication date

source string Required

Source system

title string Required

Prefilled title

Errors

AuthenticationRequired
NotFound
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
External source (e.g., arxiv, semanticscholar)
View raw schema 
{
  "type": "query",
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "NotFound"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "title",
        "abstract",
        "authors",
        "keywords",
        "source",
        "externalId",
        "externalUrl"
      ],
      "properties": {
        "doi": {
          "type": "string",
          "description": "DOI if available"
        },
        "title": {
          "type": "string",
          "description": "Prefilled title"
        },
        "pdfUrl": {
          "type": "string",
          "format": "uri",
          "description": "PDF URL if available"
        },
        "source": {
          "type": "string",
          "description": "Source system"
        },
        "authors": {
          "type": "array",
          "items": {
            "ref": "#submissionAuthor",
            "type": "ref"
          },
          "description": "Prefilled authors"
        },
        "abstract": {
          "type": "string",
          "description": "Prefilled abstract"
        },
        "keywords": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Prefilled keywords/categories"
        },
        "externalId": {
          "type": "string",
          "description": "Source-specific external ID"
        },
        "externalIds": {
          "ref": "#externalIds",
          "type": "ref"
        },
        "externalUrl": {
          "type": "string",
          "format": "uri",
          "description": "External URL to the paper"
        },
        "publicationDate": {
          "type": "string",
          "format": "datetime",
          "description": "Publication date"
        },
        "existingChivePaper": {
          "ref": "#existingChivePaper",
          "type": "ref"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "source",
      "externalId"
    ],
    "properties": {
      "source": {
        "type": "string",
        "maxLength": 50,
        "minLength": 2,
        "description": "External source (e.g., arxiv, semanticscholar)"
      },
      "externalId": {
        "type": "string",
        "description": "Source-specific identifier"
      }
    }
  },
  "description": "Get prefilled form data for claiming a paper from an external source"
}
existingAuthor object

No description available.

Properties

did string did Optional

Author DID if claimed

name string Required

Author name

View raw schema 
{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "Author DID if claimed"
    },
    "name": {
      "type": "string",
      "description": "Author name"
    }
  }
}
existingChivePaper object

Existing Chive paper if this is a duplicate

Properties

createdAt string datetime Required

When the paper was indexed

title string Required

Paper title

uri string at-uri Required

AT-URI of the existing paper

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "title",
    "authors",
    "createdAt"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the existing paper"
    },
    "title": {
      "type": "string",
      "description": "Paper title"
    },
    "authors": {
      "type": "array",
      "items": {
        "ref": "#existingAuthor",
        "type": "ref"
      },
      "description": "Author list"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the paper was indexed"
    }
  },
  "description": "Existing Chive paper if this is a duplicate"
}
externalIds object

No description available.

Properties

arxivId string Optional

arXiv identifier

doi string Optional

DOI

View raw schema 
{
  "type": "object",
  "properties": {
    "doi": {
      "type": "string",
      "description": "DOI"
    },
    "arxivId": {
      "type": "string",
      "description": "arXiv identifier"
    }
  }
}
submissionAuthor 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

order integer Required

Author order (1-indexed)

minimum: 1
View raw schema 
{
  "type": "object",
  "required": [
    "order",
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Author name"
    },
    "email": {
      "type": "string",
      "description": "Email address"
    },
    "orcid": {
      "type": "string",
      "description": "ORCID identifier"
    },
    "order": {
      "type": "integer",
      "minimum": 1,
      "description": "Author order (1-indexed)"
    },
    "affiliation": {
      "type": "string",
      "description": "Institution affiliation"
    }
  }
}

Lexicon Garden

@