DELETE
/documentClassification/deleteClassification
This endpoint permanently deletes an entire document classification process, including all associated batches, results, and uploaded files.
You must provide only the classificationId
in the request body. This action is irreversible and removes all data linked to the specified classification.
Use this endpoint when you intend to fully decommission a classification and all its related content. Separate endpoints are available for deleting individual batches or files.
Server URL
Copy https://api.extracta.ai/api/v1
Body
Name
Type
Required
Description
Body Example
Copy {
"classificationId": "classificationId"
}
Code Example
JavaScript Python PHP
Copy const axios = require('axios');
async function deleteClassification(token, classificationId) {
const url = "https://api.extracta.ai/api/v1/documentClassification/deleteClassification";
try {
const response = await axios.delete(url, {
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${token}`
},
data: {
classificationId: classificationId
}
});
return response.data;
} catch (error) {
throw error.response ? error.response.data : new Error('An unknown error occurred');
}
}
async function main() {
const token = 'apiKey';
const classificationId = 'classificationId';
try {
const response = await deleteClassification(token, classificationId);
console.log("Classification Deleted:", response);
} catch (error) {
console.error("Failed to delete classification:", error);
}
}
main();
Copy import requests
def delete_classification(token, classification_id):
url = "https://api.extracta.ai/api/v1/documentClassification/deleteClassification"
headers = {
"Content-Type": "application/json",
"Authorization": f"Bearer {token}"
}
payload = {
"classificationId": classification_id
}
try:
response = requests.delete(url, json=payload, headers=headers)
response.raise_for_status()
return response.json()
except requests.RequestException as e:
print(f"Failed to delete classification: {e}")
return None
# Example usage
if __name__ == "__main__":
token = "apiKey"
classification_id = "classificationId"
response = delete_classification(token, classification_id)
if response:
print("Classification Deleted:", response)
else:
print("Failed to delete classification.")
Copy <?php
function deleteClassification($token, $classificationId) {
$url = 'https://api.extracta.ai/api/v1/documentClassification/deleteClassification';
// Initialize cURL session
$ch = curl_init($url);
// Prepare the payload
$payload = json_encode(['classificationId' => $classificationId]);
// Set cURL options
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Content-Type: application/json',
'Authorization: Bearer ' . $token,
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
try {
$response = curl_exec($ch);
if (curl_errno($ch)) {
throw new Exception('Curl error: ' . curl_error($ch));
}
return $response;
} catch (Exception $e) {
return 'Error: ' . $e->getMessage();
} finally {
curl_close($ch);
}
}
// Example usage
$token = 'apiKey';
$classificationId = 'classificationId';
try {
$response = deleteClassification($token, $classificationId);
echo "Classification Deleted: " . $response;
} catch (Exception $e) {
echo "Failed to delete classification: " . $e->getMessage();
}
?>
Responses
200 400 500
Copy {
"status": "success",
"message": "Classification deleted"
}
Copy {
"status": "success",
"message": "Classification deleted"
}
Copy {
"status": "error",
"message": "Internal server error"
}
Last updated 17 hours ago