Skip to main content
POST
/
documents
/
delete-document
Delete Document
curl --request POST \
  --url https://api.zeroentropy.dev/v1/documents/delete-document \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "collection_name": "<string>",
  "path": "<string>"
}
'
{
  "deleted_paths": [
    "<string>"
  ]
}

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
​
collection_name
string
required

The name of the collection.

​
path
required

The path(s) of the document(s) that you are deleting. Must be either a string, or a list[str] between 1 and 64 inclusive. A 404 Not Found status code will be returned if no document(s) with this path was found. If at least one of the paths provided do exist, then 200 OK will be returned, along with an array of the document paths that were found and thus deleted.

Response

Successful Response

​
deleted_paths
string[]
required