# Extracta.ai

Extracta.ai is an AI-powered platform that automates data extraction from various document types, including PDFs, images, and text files, without requiring prior training.

- **Category:** ai document extraction
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `EXTRACTA_AI`
- **Version:** 20260217_00

## Tools

### Create Classification

**Slug:** `EXTRACTA_AI_CREATE_CLASSIFICATION`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `classificationDetails` | object | Yes | Classification configuration details including document types. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Extraction

**Slug:** `EXTRACTA_AI_CREATE_EXTRACTION`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `extractionDetails` | object | Yes | Extraction configuration details. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Classification

**Slug:** `EXTRACTA_AI_DELETE_CLASSIFICATION`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `classificationId` | string | Yes | The unique identifier of the classification process to delete. This ID is returned when creating a classification. WARNING: This action permanently deletes the entire classification process including all associated batches, results, and uploaded files. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Extraction

**Slug:** `EXTRACTA_AI_DELETE_EXTRACTION`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `extractionId` | string | Yes | The unique identifier of the extraction job to delete. This ID is returned when creating an extraction and can be obtained from the Create Extraction or View Extraction actions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Batch Results

**Slug:** `EXTRACTA_AI_GET_BATCH_RESULTS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batchId` | string | Yes | Unique identifier of the batch to retrieve results for. This ID is obtained from the extraction batches. |
| `extractionId` | string | Yes | Unique identifier of the extraction job. This ID is returned when creating an extraction using the Create Extraction action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Credits

**Slug:** `EXTRACTA_AI_GET_CREDITS`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Classification

**Slug:** `EXTRACTA_AI_UPDATE_CLASSIFICATION`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `classificationId` | string | Yes | Unique identifier of the classification to update. This ID is returned when creating a classification. |
| `classificationDetails` | object | Yes | Updated classification configuration including name, description, and document types. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Extraction

**Slug:** `EXTRACTA_AI_UPDATE_EXTRACTION`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `extractionId` | string | Yes | The unique identifier of the extraction job to update. This ID is returned when creating an extraction and can be obtained from the Create Extraction or View Extraction actions. |
| `extractionDetails` | object | Yes | Object containing the extraction parameters to update. Only fields present in this object will be modified; omitted fields remain unchanged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### View Classification

**Slug:** `EXTRACTA_AI_VIEW_CLASSIFICATION`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `classificationId` | string | Yes | Unique identifier for the classification to view. This ID is returned when creating a classification. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### View Extraction

**Slug:** `EXTRACTA_AI_VIEW_EXTRACTION`

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)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `extractionId` | string | Yes | Unique identifier of the extraction job to view. This ID is returned when creating an extraction using the Create Extraction action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |