NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Parseur connects to a Nagent workspace with an API key. Once it is connected, agents can call 26 Parseur actions, such as "Create custom download", "Create mailbox" and "Get Bootstrap Config". 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 Parseur, with input parameters and output schema.
PARSEUR_COPY_DOCUMENTTool to copy a document to another mailbox. Use when you need to duplicate a document from one mailbox to another mailbox within Parseur.
Input parameters
The unique identifier of the document to copy.
The unique identifier of the target mailbox (parser) where the document will be copied.
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
PARSEUR_COPY_MAILBOXTool to copy a mailbox (parser) in Parseur. Creates a duplicate of the mailbox with all its configuration. Use when you need to duplicate an existing parser setup.
Input parameters
Unique identifier of the mailbox (parser) to copy.
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
PARSEUR_CREATE_CUSTOM_DOWNLOADTool to create a custom download (export configuration) for a mailbox. Use when you need to define which fields should be exported to CSV or XLS format.
Input parameters
Numeric ID for the export configuration
Name for the custom download
Type of export configuration: PARSER for full parser exports, or PARSER_FIELD for field-specific exports
List of field names to include in the export. Common system fields include: DocumentID, Sender, SenderName, Template, Recipient, ParsedAt, etc.
ID of the mailbox (parser) for which to create the custom download
Identifier or filename for the CSV download
Identifier or filename for the XLS download
Parser field ID starting with PF (required when type is PARSER_FIELD)
Name of the parser field (required when type is PARSER_FIELD)
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
PARSEUR_CREATE_MAILBOXTool to create a new mailbox (parser) in Parseur. Use when you need to set up a new parser for document parsing with custom configuration.
Input parameters
The name of the parser/mailbox. If not specified, a default name will be assigned.
AI engine options for document parsing.
Whether to force OCR on every document uploaded to this parser.
General AI instructions for this parser to guide the parsing behavior.
Number of days documents and data are stored before deletion. Default is 90 days.
List of file extensions allowed for processing. If not specified, all extensions are enabled.
Master parser template options.
Whether email attachment processing is enabled on this parser.
Identification status options for the parser.
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
PARSEUR_DELETE_CUSTOM_DOWNLOADTool to delete a custom download (export configuration) from a mailbox. Use when permanently removing an export configuration after confirming its ID.
Input parameters
Unique identifier of the custom download (export configuration) to delete.
Unique identifier of the mailbox (parser) that contains the custom download. Obtain from List Mailboxes action.
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
PARSEUR_DELETE_DOCUMENTTool to delete a specific document by ID. Use when permanently removing a document after confirming its ID.
Input parameters
Unique identifier of the document to delete.
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
PARSEUR_DELETE_MAILBOXTool to delete a mailbox (parser) by ID. Use when permanently removing a mailbox after confirming its ID.
Input parameters
Unique identifier of the mailbox (parser) to delete.
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
PARSEUR_DELETE_WEBHOOKTool to delete a specific webhook. Use when permanently removing a webhook after confirming its ID.
Input parameters
Unique identifier of the webhook to delete.
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
PARSEUR_DISABLE_WEBHOOKTool to disable a webhook for a mailbox. Removes the webhook association from the specified mailbox. Use when you need to stop an active webhook from sending parsed data.
Input parameters
Unique numeric ID of the parser mailbox containing the webhook. Obtain via List Mailboxes action.
Unique numeric ID of the active webhook to disable. Obtain from webhook_set via List Webhooks action.
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
PARSEUR_ENABLE_WEBHOOKEnables a paused webhook for a specified mailbox, allowing it to receive and forward parsed document events. Use this action to re-enable a webhook that was previously paused. Only webhooks listed in 'available_webhook_set' (paused webhooks) can be enabled. After enabling, the webhook will appear in 'webhook_set' (active webhooks) and begin sending HTTP POST requests to its target URL when the configured event occurs (e.g., document.processed).
Input parameters
Unique numeric ID of the parser mailbox containing the webhook. Obtain via List Mailboxes action.
Unique numeric ID of the paused webhook to enable. Obtain from available_webhook_set via List Webhooks action.
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
PARSEUR_GET_BOOTSTRAP_CONFIGTool to retrieve bootstrap configuration data. Use when you need system-wide configuration choices, field format mappings, maximum field lengths, or master parser definitions.
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
PARSEUR_GET_DOCUMENTTool to retrieve full details of a specific document by ID. Returns document status, processing info, parsed results, and download URLs for JSON, CSV, and XLS formats.
Input parameters
The unique identifier of the document to retrieve. Obtain this ID from the List Documents action or webhook payloads.
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
PARSEUR_GET_DOCUMENT_LOGSTool to get document logs for a specific document. Returns paginated list of logs with status, source, and message details. Use when you need to troubleshoot or audit document processing history.
Input parameters
The unique identifier (numeric ID) of the document to retrieve logs for. Obtain this ID from the List Documents action.
Page number to retrieve (pagination). Defaults to 1.
Case-insensitive partial match search across log entries.
Field name to order by. Prepend a minus (-) for descending order, e.g., '-created'.
Number of log entries per page. Defaults to 25.
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
PARSEUR_GET_MAILBOXTool to retrieve full mailbox (parser) configuration by ID. Use when you need complete details about a specific mailbox including fields, webhooks, and settings.
Input parameters
The unique identifier (numeric ID) of the mailbox to retrieve. Obtain this from the List Mailboxes action.
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
PARSEUR_GET_MAILBOX_SCHEMATool to retrieve the JSON schema for a mailbox's parsed fields. Use when you need to understand the structure and types of data fields extracted by a specific parser.
Input parameters
The unique identifier (numeric ID) of the mailbox to retrieve the schema for. Obtain this ID from the List Mailboxes action.
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
PARSEUR_LIST_CUSTOM_DOWNLOADSTool to retrieve custom downloads (export configurations) for a mailbox. Use when you need to list available export formats and their download URLs.
Input parameters
The unique identifier (numeric ID) of the mailbox (parser) whose export configurations you want to list. Obtain this from the List Mailboxes action.
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
PARSEUR_LIST_DOCUMENTS_IN_MAILBOXTool to list documents within a specific mailbox. Use when you need to paginate, search, or sort the documents of a given mailbox after obtaining its ID.
Input parameters
Timezone for interpreting date filters, e.g., 'Asia/Singapore'. Defaults to UTC.
Page number to retrieve (pagination). Defaults to 1.
Search query to filter documents by ID, name, template name, sender/recipient, or metadata.
Field to sort by. Prepend a minus for descending order. Supported: name, created, modified, status.
Number of items per page. Defaults to 25.
The unique identifier (numeric ID) of the mailbox to list documents from. Obtain this ID from the List Mailboxes action.
If true, includes the full parsed result string in each document object.
Filter to include documents received on or after this date (YYYY-MM-DD).
Filter to include documents received on or before this date (YYYY-MM-DD).
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
PARSEUR_LIST_MAILBOXES2Tool to list mailboxes (parsers) with full configuration details. Returns paginated list of all mailboxes with document counts, processing statistics, and complete configuration settings. Use when you need comprehensive mailbox information including field configurations, processing options, and webhook settings.
Input parameters
Page number for pagination (default is 1).
Case-insensitive partial match search to filter mailboxes by name or email prefix.
Ordering options for mailbox list.
Number of results per page (default is 25, maximum 100).
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
PARSEUR_LIST_TEMPLATESTool to list all templates in a given mailbox. Use after fetching mailbox details when you need to page through and inspect available templates for further actions.
Input parameters
Page number to retrieve (pagination). Defaults to 1.
Filter templates whose name contains this string (case-insensitive).
Field to sort by. Prepend a minus to reverse order. Supported: name, created, modified, last_activity, status, document_count.
Number of items per page. Defaults to 25.
The numeric ID of the mailbox (parser) to list templates for. Obtain this from the List Mailboxes action.
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
PARSEUR_REPROCESS_DOCUMENTTool to reprocess a document. Triggers re-parsing of the document with the current template configuration. Use when you need to re-parse a document after template updates or to retry failed parsing.
Input parameters
Unique identifier of the document to reprocess. Obtain this ID from the List Documents action.
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
PARSEUR_RETRIEVE_WEBHOOKTool to retrieve details of a specific webhook. Use after creating or listing webhooks.
Input parameters
Unique identifier of the webhook to retrieve. Obtain from list webhooks or create webhook responses.
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
PARSEUR_SKIP_DOCUMENTTool to skip a document. Marks the document as skipped and returns the updated document with status 'SKIPPED'.
Input parameters
The unique identifier of the document to skip. Obtain this ID from list documents or document processing responses.
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
PARSEUR_UPDATE_CUSTOM_DOWNLOADTool to update a custom download (export configuration) for a mailbox. Use when you need to modify the field list, name, or export settings for an existing download configuration.
Input parameters
Unique identifier of the export configuration to update
Display name for the export configuration
Type of export configuration. Use 'PARSER' for full parser exports or 'PARSER_FIELD' for field-specific exports
List of field names to include in the export
Unique identifier of the mailbox (parser) containing the export configuration
Parser field ID starting with 'PF', required when type is 'PARSER_FIELD'
Name of the parser field, used when type is 'PARSER_FIELD'
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
PARSEUR_UPDATE_MAILBOXTool to update a mailbox (parser) configuration. Use when you need to modify mailbox settings such as name, AI engine, processing options, or document handling rules.
Input parameters
The ID of the parser/mailbox to update
The name of the parser
AI engine options for the mailbox.
Whether Parseur runs its own OCR on every document uploaded to this parser
Whether the parser is configured to process only odd page numbers in a document
Whether the parser is configured to process only even page numbers in a document
Number of pages to use for splitting documents. If set to 3, a 30-page document will be split into 10 files of 3 pages each
Whether deskew is disabled for this parser (enabled by default)
The range of pages set to be processed in the parser
Keywords the parser will look for when splitting documents by page
General AI instructions for this parser. Provide guidance for the AI engine on how to parse documents.
Default timezone for date parsing
How many days documents and data are stored on servers before deletion (90 days is the default)
Decimal separator to use for number parsing
Input date format for parsing dates
List of file extensions to process. If not present, all extensions will be enabled.
Master parser template slugs.
Whether email attachment processing is enabled on this parser
Specific page ranges to capture when splitting. Can have multiple values, e.g., 1,3-5,(1)
Identification status of the parser.
Use this to update whether the parser skips email processing and only processes attachments
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
PARSEUR_UPDATE_WEBHOOKTool to update an existing webhook’s settings. Use when you need to change the webhook’s target URL, event type, headers, or name after creation.
Input parameters
Custom name for the webhook; defaults to the target URL if omitted
Trigger event for the webhook
HTTPS URL to receive the webhook payload
Additional HTTP headers to include; Content-Type is always application/json
Unique ID of the webhook to update
ID of a specific field trigger in 'PF12345' format
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
PARSEUR_UPLOAD_EMAIL_DOCUMENTTool to upload an email or text document to Parseur for parsing. Use when you need to programmatically send documents to a Parseur mailbox.
Input parameters
CC addresses (optional).
To addresses (optional).
BCC addresses (optional).
Sender name and email address.
The title of your document, or email subject.
Document content as HTML (takes priority over plain text if both are provided).
Mailbox email address (e.g., test@in.parseur.com) where the document should be sent.
Document content as plain text.
Custom email headers as array of \[key, value\] pairs. Each pair must have exactly 2 elements.
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 26 Parseur actions on Nagent, including "Create custom download", "Create mailbox" and "Get Bootstrap Config". Create custom download: Create a custom download (export configuration) for a mailbox. Each action is listed on this page with its input parameters and its output.
Parseur 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 custom download takes 6 required inputs: id, name, items, parser_id, csv_download and xls_download. It also takes 3 optional inputs: type, parser_field_id and parser_field_name. It returns data, error and successful.