documents

Update Document

Update a document by ID.

patch/documents/{id}

Request

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

Path parameters

idstring uuid required

Request body

referencestring nullable

Extraction reference for the document

pmidstring nullable

The PubMed ID of the document.

doistring nullable

The DOI of the document.

file_namestring nullable

The name of the file.

urlstring nullable

A URL to the PDF document if it is publicly available online.

metadataobject nullable

Additional metadata for the document

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.