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": {},
  "index_status": "not_parsed"
}'

{
  "message": "Success!"
}

Documents

Update Document

Updates a document. This endpoint is atomic.

Currently both metadata and index_status are supported.

When updating with a non-null metadata, the document must have index_status of indexed. After this call, the document will have an index_status of not_indexed, since the document will need to reindex with the new metadata.
When updating with a non-null index_status, setting it to not_parsed or not_indexedrequires that the document must haveindex_statusofparsing_failedorindexing_failed`, respectively.

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

POST

documents

update-document

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": {},
  "index_status": "not_parsed"
}'

{
  "message": "Success!"
}

Authorizations

Authorization

string

header

required

The Authorization header must be provided in the format Bearer <your-api-key>.

You can get your API Key at the Dashboard!

Body

application/json

Response

200

application/json

Successful Response

The response is of type object.

Add Document Get Document Info

Status

Collections

Documents

Queries

Models

Update Document

Authorizations

Body

Response