/opencitations/works

POST /api/opencitations/works

Price: 1 credit

Get the bibliographic record OpenCitations Meta holds for one work: title, authors and editors with their ORCIDs, publication date, journal or book with its ISSNs, volume, issue, pages, publisher, and every identifier OpenCitations knows the work by

How to use it

Use this to translate between identifier spaces: one DOI, PubMed id, OpenAlex id or OMID resolves the record and returns all of the others, and the `omid` is what the citation endpoints of this platform key on. A single identifier can return more than one record where OpenCitations Meta holds separate entries for the same work, so read the list rather than the first element. There is no abstract, funding, licence or subject term here — for those go to a metadata source.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — Identifier of the work: a DOI, PubMed id, OpenAlex id or OpenCitations Meta id, written with its prefix. A plain DOI or a doi.org address is accepted too (examples: "doi:10.1038/nature12373", "pmid:23903748", "omid:br/06120344846", "openalex:W2159974629"; minLength: 1)

Response

• @type string (default: "OpenCitationsWork")
• omid string nullable
• doi string nullable
• pmid string nullable
• pmcid string nullable
• openalex string nullable
• isbns array (default: [])
• other_ids array (default: [])
• type string nullable
• pub_date string nullable
• pub_year integer nullable
• volume string nullable
• issue string nullable
• page string nullable
• authors array (default: [])
  • @type string (default: "OpenCitationsAgent")
  • name string required
  • omid string nullable
  • orcid string nullable
  • crossref string nullable
  • other_ids array (default: [])
• editors array (default: [])
  • @type string (default: "OpenCitationsAgent")
  • name string required
  • omid string nullable
  • orcid string nullable
  • crossref string nullable
  • other_ids array (default: [])
• venue object nullable
  • @type string (default: "OpenCitationsVenue")
  • name string required
  • omid string nullable
  • issns array (default: [])
  • isbns array (default: [])
  • other_ids array (default: [])
• publisher object nullable
  • @type string (default: "OpenCitationsAgent")
  • name string required
  • omid string nullable
  • orcid string nullable
  • crossref string nullable
  • other_ids array (default: [])

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — OpenCitations has no work under this identifier Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.