POST
/
api
/
v1
/
documents
/
delete
/
preview
curl --request POST \
  --url https://api.fieldwise.ai/api/v1/documents/delete/preview \
  --header 'Content-Type: application/json' \
  --data '{
  "metadata_filter": {
    "$or": [
      {
        "category": "finance"
      },
      {
        "$and": [
          {
            "status": "archived"
          },
          {
            "age": {
              "$gt": 365
            }
          }
        ]
      }
    ]
  }
}'
{
  "success": true,
  "data": {
    "document_count": 123,
    "document_ids": [
      123
    ]
  },
  "error": {
    "error_code": "RESOURCE_NOT_FOUND",
    "message": "Resource not found"
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "version": "1.0"
  }
}

Headers

X-API-Key
string | null

Body

application/json

Request model for deleting documents by metadata filter.

metadata_filter
object
required

Metadata filters using MongoDB-like query syntax

Response

200
application/json
Successful Response
data
object
required

Response data

success
boolean
default:true
error
object | null

Schema for API error responses.

Example:
{
  "error_code": "RESOURCE_NOT_FOUND",
  "message": "Resource not found"
}
meta
object

Metadata for API responses