---
canonical_url: "https://docs.composio.dev/toolkits/docupipe"
markdown_url: "https://docs.composio.dev/toolkits/docupipe.md"
product: "platform"
version: null
last_updated: null
---

# DocuPipe

DocuPipe provides document parsing, structured data extraction, classification, analysis, review, workflow, and export APIs.

- **Category:** ai document extraction
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 13
- **Triggers:** 0
- **Slug:** `DOCUPIPE`
- **Version:** 00000000_00

## Tools

### Create Schema

**Slug:** `DOCUPIPE_CREATE_SCHEMA`

Create a reusable extraction schema from a valid JSON Schema and optional extraction guidelines.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `guidelines` | string | No | Optional instructions applied when documents are standardized with this schema. |
| `json_schema` | object | Yes | Valid JSON Schema describing the structured data to extract. Arbitrary nested JSON Schema keywords and values are preserved. |
| `schema_name` | string | Yes | Name for the extraction schema. |

#### 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 Document

**Slug:** `DOCUPIPE_DELETE_DOCUMENT`

Permanently delete one previously submitted DocuPipe document by ID. This destructive operation cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | Document ID to permanently delete. |

#### 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 Documents

**Slug:** `DOCUPIPE_DELETE_DOCUMENTS`

Permanently delete multiple previously submitted DocuPipe documents by ID in one batch. This destructive operation cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_ids` | array | Yes | Document IDs to permanently delete in one batch. Provide at least one ID. |

#### 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 |

### Find Documents

**Slug:** `DOCUPIPE_FIND_DOCUMENTS`

Browse documents by dataset and creation time, or search filenames and document IDs when query is provided. Returns one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Documents per page. Browse mode supports 1-20,000; search mode supports 1-500. |
| `query` | string | No | Case-insensitive partial filename or document-ID match (1-50 characters). Omit to browse documents. |
| `dataset` | string | No | Only return documents in this dataset. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. Reuse it unchanged instead of constructing an offset. |
| `to_timestamp` | string | No | Inclusive creation-time upper bound in ISO 8601 format. Available only when query is omitted. |
| `from_timestamp` | string | No | Inclusive creation-time lower bound in ISO 8601 format. Available only when query is omitted. |
| `exclude_payload` | boolean | No | Exclude parsed result payloads from browse responses. Set false only when browse results must include content; unavailable with query. |

#### 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 |

### Find Jobs

**Slug:** `DOCUPIPE_FIND_JOBS`

Retrieve one asynchronous job by ID, or list and filter jobs when job_id is omitted. Job details expose status, progress, errors, outputs, and credit use.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Jobs to return on this list page. DocuPipe documents no maximum. |
| `job_id` | string | No | Exact job ID to retrieve. Omit to list jobs using the filters below. |
| `status` | string | No | Filter listed jobs by processing status. |
| `end_date` | string | No | List jobs on or before this date in yyyy-mm-dd format. |
| `job_type` | string | No | Filter listed jobs by DocuPipe job type. |
| `schema_id` | string | No | Filter listed jobs by schema ID. |
| `start_date` | string | No | List jobs on or after this date in yyyy-mm-dd format. |
| `document_id` | string | No | Filter listed jobs by source document ID. |
| `next_cursor` | string | No | Continuation cursor from a previous list call. Unavailable when job_id is provided. |
| `new_document_id` | string | No | Filter listed jobs by a newly created document ID, such as split or merge output. |

#### 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 Account Usage

**Slug:** `DOCUPIPE_GET_ACCOUNT_USAGE`

Return current plan and credit state together with job counts and credits consumed by job type, optionally including daily usage.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include_daily_usage` | boolean | No | Include the daily credit-usage breakdown in addition to aggregate job-type totals. |

#### 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 Document

**Slug:** `DOCUPIPE_GET_DOCUMENT`

Retrieve a processed document, including processing state, parsed content, page count, metadata, and file details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | Document ID returned by Upload Document or Find 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 |

### Get Schema

**Slug:** `DOCUPIPE_GET_SCHEMA`

Retrieve one extraction schema and its full JSON Schema definition by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `schema_id` | string | Yes | Schema ID returned by List Schemas, Create Schema, or Standardize Document. |

#### 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 Standardization

**Slug:** `DOCUPIPE_GET_STANDARDIZATION`

Retrieve one completed standardization as structured JSON, including extraction data and field metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `standardization_id` | string | Yes | Standardization ID returned by Standardize Document or List Standardizations. |

#### 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 |

### List Schemas

**Slug:** `DOCUPIPE_LIST_SCHEMAS`

List extraction schemas available to the connected workspace, optionally including each full JSON Schema payload. Returns one page and an opaque continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Schemas to return on this page (1-1000). |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. |
| `exclude_payload` | boolean | No | Exclude full jsonSchema payloads for compact discovery; set false when schema definitions are needed. |

#### 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 |

### List Standardizations

**Slug:** `DOCUPIPE_LIST_STANDARDIZATIONS`

List structured extraction results, filtered by schema, document, or up to 1000 known standardization IDs. Returns one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Results to return on this page (1-1000). |
| `schema_id` | string | No | Only return results created with this schema. |
| `document_id` | string | No | Only return results for this document. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. Reuse it unchanged. |
| `exclude_payload` | boolean | No | Exclude structured data payloads for compact discovery; set false when extraction data is needed. |
| `standardization_ids` | array | No | Specific standardization IDs to retrieve (maximum 1000). They are sent to DocuPipe as one comma-separated query value. |

#### 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 |

### Standardize Document

**Slug:** `DOCUPIPE_STANDARDIZE_DOCUMENT`

Start V3 agentic structured extraction for one processed document and return the job and standardization IDs. Standard effort costs 2 credits per page; high effort costs 4 credits per page. Omitting schema_id also consumes schema-generation credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pages` | array | No | Zero-indexed pages to standardize; omit for the entire document. |
| `timeout` | integer | No | Job timeout in seconds for webhook error reporting; not the HTTP timeout. |
| `schema_id` | string | No | Existing schema to use. If omitted, DocuPipe auto-generates and saves a draft schema, consuming schema-generation credits too. |
| `guidelines` | string | No | Extraction instructions overriding schema guidelines (maximum 50,000 characters). |
| `document_id` | string | Yes | Processed document to standardize. |
| `effort_level` | string ("standard" | "high") | No | Extraction effort: standard costs 2 credits per page; high uses the best models and costs 4 credits per page. |
| `use_metadata` | boolean | No | Include document metadata as extraction context. |

#### 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 |

### Upload Document

**Slug:** `DOCUPIPE_UPLOAD_DOCUMENT`

Submit one local file or remote file URL for asynchronous parsing. Returns the document and job IDs used to track processing. When workflow_id is provided, also run that existing workflow after parsing and return its result IDs. Processing consumes credits based on page count and workflow steps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Remote document URL. Use this when no local file is supplied; file and url cannot be combined. |
| `file` | object | No | Local document file to upload. Use this when no remote URL is supplied. |
| `pages` | array | No | Zero-indexed pages to parse. Omit or pass an empty list to parse all pages. |
| `dataset` | string | No | Dataset name used to group the document. |
| `timeout` | integer | No | Job timeout in seconds used for webhook error reporting. This is not the HTTP request timeout. |
| `filename` | string | No | Filename without its extension; forwarded as document.filename. |
| `metadata` | object | No | User metadata to attach. Its JSON-serialized size must not exceed 10 KB. |
| `file_type` | string ("pdf" | "image" | "text" | "json" | "html" | "word" | "table") | No | DocuPipe file type. Omit to let DocuPipe infer it from the content. |
| `workflow_id` | string | No | Existing workflow to run after parsing. |
| `parse_version` | integer ("1" | "2" | "3") | No | Parsing version. DocuPipe supports versions 1, 2, and 3. |
| `file_extension` | string ("pdf" | "png" | "jpeg" | "webp" | "tiff" | "txt" | "json" | "xml" | "html" | "doc" | "docx" | "csv" | "xlsx" | "xls" | "eml") | No | File extension expected by DocuPipe. For a local file, the tool infers a supported extension from its name when possible. |
| `processing_method` | string ("asImage" | "removeWatermark") | No | Optional processing method. asImage treats native PDFs as images; removeWatermark is experimental. |

#### 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 |