Documents

Update Document

Updates a document. This endpoint is atomic.

The only attribute currently supported for update is metadata. This endpoint can only be called with a non-null metadata if the document status is indexed.

Sometimes, when updating a document, a new document ID will be assigned and the previous will be deleted. For this reason, the previous and the new document ID will both be returned in the response. If the document ID was not updated, then these two IDs will be identical.

A 404 Not Found status code will be returned, if the provided collection name or document path does not exist.

POST

documents

update-document

curl --request POST \
  --url https://api.zeroentropy.dev/v1/documents/update-document \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "collection_name": "<string>",
  "path": "<string>",
  "metadata": {}
}'

{
  "previous_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "new_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Response

200

application/json

Successful Response

The response is of type object.

Add Document Get Document Info

curl --request POST \
  --url https://api.zeroentropy.dev/v1/documents/update-document \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "collection_name": "<string>",
  "path": "<string>",
  "metadata": {}
}'

{
  "previous_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "new_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Admin

Status

Collections

Documents

Queries

Parsers

Update Document

Authorizations

Body

Response