documents

Get Document

Get documents by ID, PMID, DOI, or reference.

get/documents

Request

  • Base URL
    https://extralit-public-demo.hf.space/api/v1
  • URL
    https://extralit-public-demo.hf.space/api/v1/documents
  • Auth
    • API key in header X-Extralit-Api-Key
    • or HTTP bearer

Query parameters

workspace_idstring uuid required

Workspace ID

idstring uuid nullable

Document ID

referencestring nullable

Document reference

pmidstring nullable

PubMed ID

doistring nullable

DOI

limitinteger nullable

Maximum number of documents to return

Response

Successful Response

idstring uuid required
workspace_idstring uuid required
urlstring required
file_namestring nullable required
referencestring required
pmidstring nullable required
doistring nullable required
metadataobject nullable
thumbnail_urlstring nullable

URL to the document thumbnail image

inserted_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 7 revisions of this API.