Skip to main content
Delete Extractor
curl --request DELETE \
  --url https://api.doctly.ai/api/v1/e/{extractor_id} \
  --header 'Authorization: Bearer <token>'
{
  "message": "Extractor 'Invoice Extractor' has been deleted successfully."
}
Delete an extractor from your account. This is a soft delete — the extractor is deactivated but historical extraction results remain accessible.
Some extractors installed from the catalog cannot be deleted.

Request

Headers

Authorization
string
required
Bearer token authentication. Example: Bearer YOUR_API_KEY

Path Parameters

extractor_id
string
required
The unique identifier (UUID) of the extractor to delete

Example Request

curl -X DELETE https://api.doctly.ai/api/v1/e/987fcdeb-a654-3210-9876-543210987654 \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

message
string
Success confirmation message including the extractor name

Example Responses

{
  "message": "Extractor 'Invoice Extractor' has been deleted successfully."
}

What Happens When You Delete

  • The extractor is deactivated and no longer appears in your extractor list
  • You can no longer run the extractor on new documents
  • Historical documents processed by this extractor remain accessible
  • The extractor’s slug becomes available for reuse
This action cannot be undone. If you need to restore an extractor, you’ll need to recreate it or reinstall it from the catalog.

Check Before Deleting

Before deleting, you may want to verify there are no active integrations using this extractor:
import requests

extractor_id = "987fcdeb-a654-3210-9876-543210987654"
headers = {"Authorization": "Bearer YOUR_API_KEY"}

# Check for recent documents using this extractor
response = requests.get(
    "https://api.doctly.ai/api/v1/documents",
    headers=headers,
    params={"extractor_id": extractor_id, "limit": 10}
)

data = response.json()
if data["count"] > 0:
    print(f"Warning: {data['count']} documents were processed with this extractor")
    for doc in data["data"][:5]:
        print(f"  - {doc['file_name']} ({doc['created_at']})")
else:
    print("No documents found. Safe to delete.")

Authorizations

Authorization
string
header
required

API key authentication using Bearer token

Path Parameters

extractor_id
string<uuid>
required

Extractor ID

Response

Extractor deleted

message
string
required