NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Aryn connects to a Nagent workspace with an API key. Once it is connected, agents can call 9 Aryn actions, such as "Create DocSet", "Get DocSet Metadata" and "Get Document by ID". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Aryn, with input parameters and output schema.
ARYN_CREATE_DOCSETTool to create a new DocSet. Use when you need to allocate a storage container before adding documents.
Input parameters
String name for the DocSet
Optional schema object defining document properties
Optional dictionary of prompts for the DocSet
Optional dictionary of additional properties
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ARYN_GET_DOC_SETTool 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.
Input parameters
Unique identifier of the DocSet to retrieve. Format: 'aryn:ds-<alphanumeric>'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ARYN_LIST_ASYNC_TASKSTool to list all outstanding asynchronous tasks for the account. Use when you need to check pending or running tasks.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ARYN_PARTITION_DOCUMENTPartition 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 content from PDFs or other document formats.
Input parameters
File to partition. Either file or file_url must be provided.
Comprehensive options for document partitioning
URL of the file to partition. Either file or file_url must be provided.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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.
DocParse options to use during partitioning, provided as a JSON string.
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>'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 9 Aryn actions on Nagent, including "Create DocSet", "Get DocSet Metadata" and "Get Document by ID". Create DocSet: Create a new DocSet. Each action is listed on this page with its input parameters and its output.
Aryn connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create DocSet takes 1 required input: name. It also takes 3 optional inputs: schema, prompts and properties. It returns data, error and successful.