- Category: documents & ocr
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 9
- Triggers: 0
- Slug:
ARYN - Version: 20261101_00
Tools
Create DocSet
Create DocSet
Delete DocSet
Delete DocSet
Slug:
ARYN_DELETE_DOCSETTool to delete a DocSet and all its documents. Use after confirming the DocSet ID, when you need to permanently remove a DocSet and its contents.Input Parameters
The unique identifier of the DocSet to delete. Format is typically ‘aryn:ds-xxxxx’ where xxxxx is an alphanumeric string.
Output
Generate plan
Generate plan
Slug:
ARYN_GENERATE_PLANTool to generate a query plan without executing it. Use when you need to review the logical plan before running your query (e.g., “Generate a plan for revenue breakdown by region”).Input Parameters
Natural language query string to generate a plan for. The query will be converted into a logical execution plan with operators.
If true, the query will generate only a RAG (Retrieval Augmented Generation) query plan instead of a full analytics plan.
The unique identifier of the DocSet to query. Format: ‘aryn:ds-{id}’. Find DocSet IDs in the Aryn UI or via the list docsets API.
Output
Get DocSet Metadata
Get DocSet Metadata
Get Document by ID
Get Document by ID
Slug:
ARYN_GET_DOCUMENTRetrieve a document by ID from Aryn DocParse storage. Returns the document’s parsed elements (text, tables, sections with embeddings), custom properties, and optionally the original binary content. Use this after obtaining a docset_id and doc_id from other Aryn actions (e.g., list_docs or add_doc).Input Parameters
The unique identifier of the document to retrieve. Format: ‘aryn:f-xxxxxxxxxxxxxxxxxxxx’.
The unique identifier of the DocSet containing the document. Format: ‘aryn:ds-xxxxxxxxxxxxxxxxxxxx’.
When true, includes the base64-encoded original document binary data. Set to true only if you need the raw file content.
When true, includes parsed document elements (sections, tables, text blocks, etc.) with their embeddings and text representations. Set to false if you only need document metadata.
Output
Download Document Binary
Download Document Binary
Slug:
ARYN_GET_DOCUMENT_BINARYDownload the original binary content (e.g., PDF, image) of a document from an Aryn DocSet. This action retrieves the raw binary file that was originally uploaded to the DocSet. Use this when you need to access the original document file rather than the parsed elements or extracted text.Input Parameters
The unique identifier of the DocSet containing the document. Format: ‘aryn:ds-<alphanumeric_id>’ (e.g., ‘aryn:ds-n1uckj87hwf2d95kwr5gsh1’).
The unique identifier of the document to download. Format: ‘aryn:f-<alphanumeric_id>’ (e.g., ‘aryn:f-8dkwobf4oihjlhz7koqlqfr’).
Output
List Async Tasks
List Async Tasks
Partition Document
Partition Document
Slug:
ARYN_PARTITION_DOCUMENTPartition an uploaded document or URL using Aryn DocParse to extract structured text, tables, and images. Supports options for chunking, OCR, table and image extraction, and output format; the response exposes parsed elements and Markdown when returned.Input Parameters
Output
Submit Document for Async Add Doc
Submit Document for Async Add Doc
Slug:
ARYN_SUBMIT_ASYNC_ADD_DOCTool to submit a document for asynchronous addition to a DocSet. Returns a task ID to track the operation. Use when you need to add documents to an existing DocSet and want to track the processing status.Input Parameters
The file to upload to the Aryn platform. Either ‘file’ or ‘file_url’ must be provided, but not both.
URL of the file to add to the Aryn platform. Either ‘file’ or ‘file_url’ must be provided, but not both.
The unique identifier of the docset to which to add the document. Format: ‘aryn:ds-<alphanumeric>’.