FieldwiseAI - API Documentation

Delete Document By External Id

curl --request DELETE \
  --url https://api.fieldwise.ai/api/v1/documents/external/{external_id} \
  --header 'X-API-Key: <api-key>'

{
  "data": {
    "deleted_count": 123,
    "deleted_ids": [
      123
    ]
  },
  "success": true,
  "error": {
    "error_code": "RESOURCE_NOT_FOUND",
    "message": "Resource not found"
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "version": "1.0"
  }
}

DELETE

api

documents

external

{external_id}

Delete Document By External Id

curl --request DELETE \
  --url https://api.fieldwise.ai/api/v1/documents/external/{external_id} \
  --header 'X-API-Key: <api-key>'

{
  "data": {
    "deleted_count": 123,
    "deleted_ids": [
      123
    ]
  },
  "success": true,
  "error": {
    "error_code": "RESOURCE_NOT_FOUND",
    "message": "Resource not found"
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "version": "1.0"
  }
}

Authorizations

X-API-Key

string

header

required

Headers

X-API-Key

string | null

Path Parameters

external_id

string

required

Query Parameters

latest_only

boolean

default:true

If True, delete only the latest version. If False, delete all versions with this external_id.

Response

Successful Response

data

DeleteResponseData · object

required

Response data

Show child attributes

success

boolean

default:true

error

ErrorDetail · object

Schema for API error responses.

Show child attributes

Example:

{
  "error_code": "RESOURCE_NOT_FOUND",
  "message": "Resource not found"
}