Submit documents to DocuPipe, extract structured data with schemas, classify, split and merge documents, and run reviews, workflows and transformations.
Explore 61 workflow actions for DocuPipe, including account permissions and operation limits.
32 read actions29 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Apply transformations
Write
Run one or more saved transformations, in the order given, on an existing standardization or on a structured document (CSV, Excel, JSON or XML).
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create transformation
Write
Create a transformation: a rule that runs on extraction results, such as reformatting names, converting units, or adding a field calculated from other fields.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete class
Write
Delete a class from the taxonomy of classes by providing the class ID.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete document
Write
Delete a document that has been previously submitted to DocuPipe for processing.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete documents
Write
Delete multiple documents that have been previously submitted to DocuPipe for processing.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete jobs
Write
Delete multiple jobs that have been submitted to DocuPipe for processing.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete reviews
Write
This endpoint is used to delete multiple review object.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete schema
Write
Delete a schema by its id.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete standardization
Write
Delete a standardization by providing the standardization ID.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete standardizations
Write
Delete multiple standardizations at once by providing a list of standardization IDs.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete workflow
Write
Delete a workflow by providing the workflow ID.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get account
Read
Get information about your account, including the plan name, pricing regime, number of remaining credits, the number of overage credits, and the details of the upcoming invoice.
Permissions and limits
Account permissions
A DocuPipe API key
Get convert excel
Read
Get the status of an Excel conversion.
Permissions and limits
Account permissions
A DocuPipe API key
Get document
Read
Access the analysis results of your submitted document using this endpoint.
Permissions and limits
Account permissions
A DocuPipe API key
Get document detailed
Read
Access the fine grained document parsing result.
Permissions and limits
Account permissions
A DocuPipe API key
Get document summary
Read
Get a count of your documents, including the total number of documents, as well as the list of unique datasets.
Permissions and limits
Account permissions
A DocuPipe API key
Get document transformation result
Read
Retrieve the latest transformed result stored on a structured document (CSV, Excel, JSON or XML), with the transformations that produced it.
Permissions and limits
Account permissions
A DocuPipe API key
Get job
Read
Retrieve the details of a specific job by providing the job's ID.
Permissions and limits
Account permissions
A DocuPipe API key
Get job summary
Read
Get a count of your jobs broken down by Job Type.
Permissions and limits
Account permissions
A DocuPipe API key
Get proposed schemas
Read
Get schema proposals for a document by providing the document's ID.
Permissions and limits
Account permissions
A DocuPipe API key
Get review by id
Read
This endpoint is used to retrieve a review object its unique ID.
Permissions and limits
Account permissions
A DocuPipe API key
Get schema
Read
Retrieve an existing schema by providing the schema's ID.
Permissions and limits
Account permissions
A DocuPipe API key
Get schema summary
Read
Get the total number of schemas for the authenticated user.
Permissions and limits
Account permissions
A DocuPipe API key
Get standardization
Read
Retrieve the standardization results of a document as a JSON object.
Permissions and limits
Account permissions
A DocuPipe API key
Get standardization review
Read
This endpoint is used to retrieve a review object by its associated standardization ID.
Permissions and limits
Account permissions
A DocuPipe API key
Get standardization summary
Read
Get a count of your standardizations, including the total number as well as the list of unique schema names.
Permissions and limits
Account permissions
A DocuPipe API key
Get standardization text
Read
Retrieve the standardization results of a document as a human-readable plaintext document.
Permissions and limits
Account permissions
A DocuPipe API key
Get standardization xml
Read
Retrieve the standardization results of a document as an XML object.
Permissions and limits
Account permissions
A DocuPipe API key
Get transformation
Read
Retrieve one of your saved transformations by its ID, with its code and review.
Permissions and limits
Account permissions
A DocuPipe API key
Get transformation result
Read
Retrieve the latest transformed result stored on a standardization, with the transformations that produced it.
Permissions and limits
Account permissions
A DocuPipe API key
List classes
Read
List all classes that have been defined in the taxonomy.
Permissions and limits
Account permissions
A DocuPipe API key
List datasets
Read
List all dataset names for the documents you have submitted so far.
Permissions and limits
Account permissions
A DocuPipe API key
List documents
Read
List all documents that have been submitted to DocuPipe for processing.
Permissions and limits
Account permissions
A DocuPipe API key
List extractions
Read
Retrieve standardization and reasoning extraction results in one list.
Permissions and limits
Account permissions
A DocuPipe API key
List jobs
Read
List all jobs that have been submitted to DocuPipe for processing.
Permissions and limits
Account permissions
A DocuPipe API key
List reviews
Read
This endpoint is used to list all review objects.
Permissions and limits
Account permissions
A DocuPipe API key
List schemas
Read
List all of your schemas.
Permissions and limits
Account permissions
A DocuPipe API key
List standardizations
Read
Retrieve all standardizations of documents that have been processed using a specific schema.
Permissions and limits
Account permissions
A DocuPipe API key
List transformations
Read
List your saved transformations, newest first, with their code.
Permissions and limits
Account permissions
A DocuPipe API key
List workflows
Read
This endpoint returns a list of all your workflows.
Permissions and limits
Account permissions
A DocuPipe API key
Post add class
Write
Add a new class to the taxonomy of classes, including name and description.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Post classify batch
Write
Classify a batch of one or multiple documents all at once by passing a list of document IDs, and an optional list of class IDs to use for classification.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Post convert excel
Write
Convert a document into an Excel file.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Post edit class
Write
Edit an existing class's name or description.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Post edit schema
Write
Edit a schema by providing a schema ID and the parameters you want to edit.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Post merge
Write
Merge multiple documents into a single PDF document.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Post merge standardizations
Write
Combine several standardizations into a single new standardization on a target document.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Post schema
Write
Create a new schema manually by posting a valid JSON schema.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Post schema autogenerate
Write
Generate a schema based on a list of documents.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Post split document
Write
Split a document into multiple documents intelligently using AI.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Post standardize v3
Write
Standardize a single document using the V3 agentic engine.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Post workflow on submit document
Write
Use this endpoint to create a workflow that triggers when a document is submitted.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run workflow v2
Write
Run a workflow on one or more documents.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Search documents
Read
Search documents by filename or document ID using case-insensitive partial matching.
Permissions and limits
Account permissions
A DocuPipe API key
Search schemas
Read
Search schemas by schema name or schema ID using case-insensitive partial matching.
Permissions and limits
Account permissions
A DocuPipe API key
Search standardizations
Read
Search standardizations by filename, document ID, or standardization ID using case-insensitive partial matching.
Permissions and limits
Account permissions
A DocuPipe API key
Submit document
Write
Use this endpoint to submit a document to DocuPipe for processing.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update documents dataset
Write
Update the dataset of a list of documents by providing a list of document IDs and the new dataset name.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update documents metadata
Write
Replace the user-supplied metadata dict on one or more existing documents.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update review
Write
This endpoint is used to update a review object with new data or status.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update workflow
Write
Update an existing workflow by posting the same parameters as POST /workflow/on-submit-document.
Permissions and limits
Account permissions
A DocuPipe API key
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in DocuPipe. A saved workflow is not a completed provider action.