Action★ Featured
Create DocSet
ARYN_CREATE_DOCSETCreates a new DocSet, a storage container for organizing and managing documents, essential before adding any files.
Aryn
Reference
9 actions for Aryn workflows.
Act on Aryn from a workflow
Operations are the actions a workflow can take in Aryn, grouped by category. Each lists its method, parameters, and a template you can drop it into.
DocSets
4 operationsThese operations manage groups of documents called DocSets. You can create a new DocSet, add documents to it asynchronously, retrieve its metadata, or delete it entirely. Use them when you need to organize and batch process documents for building a searchable knowledge base.
Action
Delete DocSet
ARYN_DELETE_DOCSETPermanently removes a DocSet and all its associated documents from the system. Use this to clean up outdated or unnecessary document groups to maintain an organized workspace.
Action
Get DocSet Metadata
ARYN_GET_DOC_SETFetches metadata for a document set, including its name, creation time, properties, and prompts, allowing you to review or validate document set details before further actions.
Action
Submit Document for Async Add Doc
ARYN_SUBMIT_ASYNC_ADD_DOCSubmits a document to be added to a DocSet asynchronously, returning a task ID to track the processing status. Ideal for adding documents without blocking your workflow.
Documents
3 operationsThese handle individual document operations, from partitioning a document into its constituent parts to retrieving metadata or downloading the raw file. They are essential for processing documents through the Aryn pipeline and accessing the results.
Action★ Featured
Download Document Binary
ARYN_GET_DOCUMENT_BINARYRetrieves the original uploaded file (e.g., PDF, image) from a document collection, giving you direct access to the raw binary for offline use, sharing, or external processing.
Action★ Featured
Get Document by ID
ARYN_GET_DOCUMENTRetrieves a parsed document with its text, tables, sections, and embeddings from Aryn storage, along with the optional original binary content, enabling you to access and analyze documents after they have been uploaded.
Action★ Featured
Partition Document
ARYN_PARTITION_DOCUMENTExtracts and structures content from documents like PDFs, breaking down text, tables, and images into usable data for further processing or analysis.
Plans
1 operationThis operation creates a processing plan that outlines how to partition and analyze documents. Use it when you need to define the steps for document processing before executing them.
Action
Generate plan
ARYN_GENERATE_PLANPreview the logical steps of a database query without executing it, so you can check for errors or optimize performance before running expensive operations.
Tasks
1 operationThis operation retrieves the status of asynchronous tasks, such as document additions to DocSets. It helps you track progress and completion of long-running operations.
Action
List Async Tasks
ARYN_LIST_ASYNC_TASKSRetrieves a list of all pending or running asynchronous tasks for your account, enabling you to monitor their progress and quickly identify any that require attention.
Use Aryn in a workflow
Drop a trigger and an action into a template; approve from your phone; the workflow runs.