Extracta.ai

Creates a new document classification configuration. Define a list of possible document types with their characteristics (name, description, unique words). Returns a classification ID that can be used to upload documents for automatic type prediction. This is the first step before uploading documents for classification.

Creates a new extraction configuration for processing documents. Define what fields to extract (e.g., names, dates, amounts) and processing options. Returns an extraction ID that can be used to upload and process files. This is the first step before uploading documents for extraction.

Permanently deletes an entire document classification process including all associated batches, results, and uploaded files. Use this when you want to remove a classification that is no longer needed. WARNING: This action cannot be undone.

Permanently deletes an extraction job and its configuration from the system. Use this when you want to remove an extraction job that is no longer needed. This action is idempotent - calling it multiple times with the same ID will not cause errors. Requires the extraction ID obtained from creating or viewing an extraction.

Retrieves extraction results for a specific batch of documents. Returns the extracted data for each file in the batch, along with processing status and file information. If the batch is still processing, results may be empty or incomplete. Maintain 2-second intervals between consecutive requests to avoid rate-limiting.

Retrieves the current credit balance available on the account. The system operates on a per-page consumption model where 1 credit = 1 page of document processing. Use this action to check remaining credits before processing documents.

Updates an existing document classification by modifying its parameters. Use this to change the classification name, description, or document types (including their keywords and linked extractions). Requires the classification ID from a previously created classification.

Updates an existing document extraction process by modifying specified parameters. Only fields provided in the request are modified; omitted fields remain unchanged. Use this to change the extraction's name, description, language, fields to extract, or processing options without recreating the entire extraction job.

Retrieves details of an existing classification configuration including name, description, document types, associated keywords, and linked extraction templates. Use this action to verify classification setup or retrieve configuration details for debugging and auditing purposes.

Retrieves detailed configuration and status information for an existing extraction job. Returns the extraction's name, description, language, configured fields, processing options, and any associated batches. Use this action to: - Check the configuration of an extraction job - Verify the fields that will be extracted - View processing options (table extraction, handwriting recognition, etc.) - Monitor batch status if files have been uploaded for processing Requires: extraction_id from a previously created extraction (via Create Extraction action)