Skip to main content
Parseur logo
  • Category: ai document extraction
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 26
  • Triggers: 0
  • Slug: PARSEUR
  • Version: 20261101_00

Tools

Slug: 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

string
required
The unique identifier of the document to copy.
string
required
The unique identifier of the target mailbox (parser) where the document will be copied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Unique identifier of the mailbox (parser) to copy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Numeric ID for the export configuration
string
required
Name for the custom download
string ("PARSER" | "PARSER_FIELD")
Type of export configuration: PARSER for full parser exports, or PARSER_FIELD for field-specific exports
array
required
List of field names to include in the export. Common system fields include: DocumentID, Sender, SenderName, Template, Recipient, ParsedAt, etc.
string
required
ID of the mailbox (parser) for which to create the custom download
string
required
Identifier or filename for the CSV download
string
required
Identifier or filename for the XLS download
string
Parser field ID starting with PF (required when type is PARSER_FIELD)
string
Name of the parser field (required when type is PARSER_FIELD)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The name of the parser/mailbox. If not specified, a default name will be assigned.
string ("DISABLED" | "GCP_AI_1" | "GCP_AI_2" | "GCP_AI_2_5")
AI engine options for document parsing.
boolean
Whether to force OCR on every document uploaded to this parser.
string
General AI instructions for this parser to guide the parsing behavior.
integer
Number of days documents and data are stored before deletion. Default is 90 days.
array
List of file extensions allowed for processing. If not specified, all extensions are enabled.
string ("invoices" | "statements" | "job-application" | "leads" | "resume-cv" | "food-delivery" | "search-alerts" | "real-estate" | "work-order" | "financial-statement" | "utility" | "contact-list" | "delivery-notes" | "property-bookings" | "job-search" | "travel" | "automotive" | "payslip" | "event-ticketing")
Master parser template options.
boolean
Whether email attachment processing is enabled on this parser.
string ("REQUESTED" | "PROGRESS" | "COMPLETED" | "MANUAL")
Identification status options for the parser.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier of the custom download (export configuration) to delete.
string
required
Unique identifier of the mailbox (parser) that contains the custom download. Obtain from List Mailboxes action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PARSEUR_DELETE_DOCUMENTTool to delete a specific document by ID. Use when permanently removing a document after confirming its ID.

Input Parameters

string
required
Unique identifier of the document to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PARSEUR_DELETE_MAILBOXTool to delete a mailbox (parser) by ID. Use when permanently removing a mailbox after confirming its ID.

Input Parameters

integer
required
Unique identifier of the mailbox (parser) to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PARSEUR_DELETE_WEBHOOKTool to delete a specific webhook. Use when permanently removing a webhook after confirming its ID.

Input Parameters

integer
required
Unique identifier of the webhook to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Unique numeric ID of the parser mailbox containing the webhook. Obtain via List Mailboxes action.
integer
required
Unique numeric ID of the active webhook to disable. Obtain from webhook_set via List Webhooks action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Unique numeric ID of the parser mailbox containing the webhook. Obtain via List Mailboxes action.
integer
required
Unique numeric ID of the paused webhook to enable. Obtain from available_webhook_set via List Webhooks action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the document to retrieve. Obtain this ID from the List Documents action or webhook payloads.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (numeric ID) of the document to retrieve logs for. Obtain this ID from the List Documents action.
integer
Page number to retrieve (pagination). Defaults to 1.
Case-insensitive partial match search across log entries.
string
Field name to order by. Prepend a minus (-) for descending order, e.g., ‘-created’.
integer
Number of log entries per page. Defaults to 25.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier (numeric ID) of the mailbox to retrieve. Obtain this from the List Mailboxes action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (numeric ID) of the mailbox to retrieve the schema for. Obtain this ID from the List Mailboxes action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PARSEUR_LIST_CUSTOM_DOWNLOADSRetrieve custom downloads (export configurations) and their download URLs for a mailbox. Returns one page of configurations; the tool does not accept a page selector.

Input Parameters

string
required
The unique identifier (numeric ID) of the mailbox (parser) whose export configurations you want to list. Obtain this from the List Mailboxes action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Timezone for interpreting date filters, e.g., ‘Asia/Singapore’. Defaults to UTC.
integer
Page number to retrieve (pagination). Defaults to 1.
string
Search query to filter documents by ID, name, template name, sender/recipient, or metadata.
string ("name" | "-name" | "created" | "-created" | "modified" | "-modified" | "status" | "-status")
Field to sort by. Prepend a minus for descending order. Supported: name, created, modified, status.
integer
Number of items per page. Defaults to 25.
string
required
The unique identifier (numeric ID) of the mailbox to list documents from. Obtain this ID from the List Mailboxes action.
boolean
If true, includes the full parsed result string in each document object.
string
Filter to include documents received on or after this date (YYYY-MM-DD).
string
Filter to include documents received on or before this date (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PARSEUR_LIST_MAILBOXES2List mailboxes with pagination, document counts, processing statistics, and configuration details such as field settings, processing options, and webhooks.

Input Parameters

integer
Page number for pagination (default is 1).
string
Case-insensitive partial match search to filter mailboxes by name or email prefix.
string ("name" | "-name" | "document_count" | "-document_count" | "template_count" | "-template_count" | "PARSEDOK_count" | "-PARSEDOK_count" | "PARSEDKO_count" | "-PARSEDKO_count" | "QUOTAEXC_count" | "-QUOTAEXC_count" | "EXPORTKO_count" | "-EXPORTKO_count" | "TRANSKO_count" | "-TRANSKO_count")
Ordering options for mailbox list.
integer
Number of results per page (default is 25, maximum 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to retrieve (pagination). Defaults to 1.
string
Filter templates whose name contains this string (case-insensitive).
string ("name" | "-name" | "created" | "-created" | "modified" | "-modified" | "last_activity" | "-last_activity" | "status" | "-status" | "document_count" | "-document_count")
Field to sort by. Prepend a minus to reverse order. Supported: name, created, modified, last_activity, status, document_count.
integer
Number of items per page. Defaults to 25.
string
required
The numeric ID of the mailbox (parser) to list templates for. Obtain this from the List Mailboxes action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier of the document to reprocess. Obtain this ID from the List Documents action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PARSEUR_RETRIEVE_WEBHOOKTool to retrieve details of a specific webhook. Use after creating or listing webhooks.

Input Parameters

string
required
Unique identifier of the webhook to retrieve. Obtain from list webhooks or create webhook responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PARSEUR_SKIP_DOCUMENTTool to skip a document. Marks the document as skipped and returns the updated document with status ‘SKIPPED’.

Input Parameters

string
required
The unique identifier of the document to skip. Obtain this ID from list documents or document processing responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PARSEUR_UPDATE_CUSTOM_DOWNLOADUpdate a mailbox’s custom download configuration, including its name, field list, or export type. The export type defaults to PARSER and is sent even when omitted.

Input Parameters

integer
required
Unique identifier of the export configuration to update
string
Display name for the export configuration
string ("PARSER" | "PARSER_FIELD")
Type of export configuration. Use ‘PARSER’ for full parser exports or ‘PARSER_FIELD’ for field-specific exports
array
List of field names to include in the export
string
required
Unique identifier of the mailbox (parser) containing the export configuration
string
Parser field ID starting with ‘PF’, required when type is ‘PARSER_FIELD’
string
Name of the parser field, used when type is ‘PARSER_FIELD’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the parser/mailbox to update
string
The name of the parser
string ("DISABLED" | "GCP_AI_1" | "GCP_AI_2" | "GCP_AI_2_5")
AI engine options for the mailbox.
boolean
Whether Parseur runs its own OCR on every document uploaded to this parser
boolean
Whether the parser is configured to process only odd page numbers in a document
boolean
Whether the parser is configured to process only even page numbers in a document
integer
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
boolean
Whether deskew is disabled for this parser (enabled by default)
array
The range of pages set to be processed in the parser
array
Keywords the parser will look for when splitting documents by page
string
General AI instructions for this parser. Provide guidance for the AI engine on how to parse documents.
string
Default timezone for date parsing
integer
How many days documents and data are stored on servers before deletion (90 days is the default)
string
Decimal separator to use for number parsing
string
Input date format for parsing dates
array
List of file extensions to process. If not present, all extensions will be enabled.
string ("invoices" | "statements" | "job-application" | "leads" | "resume-cv" | "food-delivery" | "search-alerts" | "real-estate" | "work-order" | "financial-statement" | "utility" | "contact-list" | "delivery-notes" | "property-bookings" | "job-search" | "travel" | "automotive" | "payslip" | "event-ticketing")
Master parser template slugs.
boolean
Whether email attachment processing is enabled on this parser
array
Specific page ranges to capture when splitting. Can have multiple values, e.g., 1,3-5,(1)
string ("REQUESTED" | "PROGRESS" | "COMPLETED" | "MANUAL")
Identification status of the parser.
boolean
Use this to update whether the parser skips email processing and only processes attachments

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Custom name for the webhook; defaults to the target URL if omitted
string ("document.processed" | "document.processed.flattened" | "document.template_needed" | "table.processed")
Trigger event for the webhook
string
HTTPS URL to receive the webhook payload
object
Additional HTTP headers to include; Content-Type is always application/json
integer
required
Unique ID of the webhook to update
string
ID of a specific field trigger in ‘PF12345’ format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
CC addresses (optional).
string
To addresses (optional).
string
BCC addresses (optional).
string
required
Sender name and email address.
string
required
The title of your document, or email subject.
string
Document content as HTML (takes priority over plain text if both are provided).
string
required
Mailbox email address (e.g., test@in.parseur.com) where the document should be sent.
string
Document content as plain text.
array
Custom email headers as array of [key, value] pairs. Each pair must have exactly 2 elements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not