Skip to main content
DocuPipe logo
  • Category: ai document extraction
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 13
  • Triggers: 0
  • Slug: DOCUPIPE
  • Version: 20261101_00

Tools

Slug: DOCUPIPE_CREATE_SCHEMACreate a reusable extraction schema from a valid JSON Schema and optional extraction guidelines.

Input Parameters

string
Optional instructions applied when documents are standardized with this schema.
object
required
Valid JSON Schema describing the structured data to extract. Arbitrary nested JSON Schema keywords and values are preserved.
string
required
Name for the extraction schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUPIPE_DELETE_DOCUMENTPermanently delete one previously submitted DocuPipe document by ID. This destructive operation cannot be undone.

Input Parameters

string
required
Document ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUPIPE_DELETE_DOCUMENTSPermanently delete multiple previously submitted DocuPipe documents by ID in one batch. This destructive operation cannot be undone.

Input Parameters

array
required
Document IDs to permanently delete in one batch. Provide at least one ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUPIPE_FIND_DOCUMENTSBrowse 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUPIPE_FIND_JOBSRetrieve 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUPIPE_GET_ACCOUNT_USAGEReturn current plan and credit state together with job counts and credits consumed by job type, optionally including daily usage.

Input Parameters

boolean
Include the daily credit-usage breakdown in addition to aggregate job-type totals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUPIPE_GET_DOCUMENTRetrieve a processed document, including processing state, parsed content, page count, metadata, and file details.

Input Parameters

string
required
Document ID returned by Upload Document or Find Documents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUPIPE_GET_SCHEMARetrieve one extraction schema and its full JSON Schema definition by ID.

Input Parameters

string
required
Schema ID returned by List Schemas, Create Schema, or Standardize Document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUPIPE_GET_STANDARDIZATIONRetrieve one completed standardization as structured JSON, including extraction data and field metadata.

Input Parameters

string
required
Standardization ID returned by Standardize Document or List Standardizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUPIPE_LIST_SCHEMASList extraction schemas available to the connected workspace, optionally including each full JSON Schema payload. Returns one page and an opaque continuation cursor.

Input Parameters

integer
Schemas to return on this page (1-1000).
string
Continuation cursor returned by a previous call.
boolean
Exclude full jsonSchema payloads for compact discovery; set false when schema definitions are needed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUPIPE_LIST_STANDARDIZATIONSList standardizations, optionally filtered by schema, document, or up to 1000 standardization IDs, returning one page and a continuation cursor when more may be available. Structured extraction payloads are excluded by default and can be included.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUPIPE_STANDARDIZE_DOCUMENTStart 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUPIPE_UPLOAD_DOCUMENTSubmit 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not