API_KEY
aryn_api_key
Developer setup
No fields declared in this snapshot.
User connection
- Aryn API Keygeneric_api_key · stringRequired
ARYN
Aryn is an AI-powered platform for document parsing, data extraction, and analytics, enabling users to process and query unstructured documents at scale.
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
9
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
API_KEY
No fields declared in this snapshot.
Capability index
Showing 1–9 of 9 actions
ARYN_CREATE_DOCSET
Tool to create a new DocSet. Use when you need to allocate a storage container before adding documents.
Untrusted display-only summary
ARYN_DELETE_DOCSET
Tool 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.
Untrusted display-only summary
ARYN_GENERATE_PLAN
Tool 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").
Untrusted display-only summary
ARYN_GET_DOC_SET
Tool to retrieve metadata for a specific DocSet by its ID. Use when you need to check DocSet details like name, creation time, properties, or prompts.
Untrusted display-only summary
ARYN_GET_DOCUMENT
Retrieve 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).
Untrusted display-only summary
ARYN_GET_DOCUMENT_BINARY
Download 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.
Untrusted display-only summary
ARYN_LIST_ASYNC_TASKS
Tool to list all outstanding asynchronous tasks for the account. Use when you need to check pending or running tasks.
Untrusted display-only summary
ARYN_PARTITION_DOCUMENT
Partition a document using Aryn DocParse to extract and structure its content elements including text, tables, and images. Supports file upload or URL input with extensive processing options for chunking, OCR, table extraction, image extraction, and multiple output formats. Use when you need to extract structured cont…
Untrusted display-only summary
ARYN_SUBMIT_ASYNC_ADD_DOC
Tool 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.
Untrusted display-only summary
Provenance
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.