records

Update Record

Changed on
patch/records/{record_id}

Request

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

Path parameters

record_idstring uuid required

Request body

fieldsobject nullable
metadataobject nullable
referencestring nullable

An external reference (e.g. a DOI) for the record's source document

vectorsobject nullable

Response

Successful Response

idstring uuid required
status'pending' | 'completed' required
fieldsobject required
metadataobject nullable
external_idstring nullable
referencestring nullable
vectorsobject nullable
dataset_idstring uuid required
inserted_atstring date-time required
updated_atstring date-time required

Changes

  • ca32894f988cRevision changes
    • breaking

      removed subschema #6 subschema #7 from the /// request property anyOf list

    • info

      added subschema #6 subschema #7 to the /// request property anyOf list

  • e9da3a893a88Revision changes
    • info

      added the new optional request property

    • info

      added subschema #7 to the /// request property anyOf list

    • info

      added the optional property to the response with the status