The Parseur connector lets your AI agent act in each user's Parseur account. Each user connects their own Parseur API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 27 tools.
- Tools
- 27
- What they doRead · write · destructive
- 9 · 12 · 69 read12 write6 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Parseur connection
In AgentKit > Connections, create a Parseur connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'parseur'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Parseur:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'parseur_mailboxes_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "parseur"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Parseur:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="parseur_mailboxes_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Parseur credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolparseur_document_getGet one Parseur document with its parsed result.Read-onlyGet Document
Get one Parseur document with its parsed result. Returns the document's name, status, dates, template, content links and the parsed result JSON. Use parseur_documents_list to find the ID.
Inputs
idstringrequired- ID of the document. Find it with parseur_documents_list. Example: 9a1b2c3d4e5f.
parseur_document_logs_listList the processing log entries of a Parseur document (received, parsed, exported, errors).Read-onlyList Document Logs
List the processing log entries of a Parseur document (received, parsed, exported, errors). Returns results[] of log entries with date, status and message. Use to find why a document failed or was not exported.
Inputs
idstringrequired- ID of the document. Find it with parseur_documents_list. Example: 9a1b2c3d4e5f.
orderingstring- Field name to order by (use -prefix for descending) Example: -created.
pageinteger- Page number for pagination (default is 1)
page_sizeinteger- Number of results per page (default is 25) Example: 50.
searchstring- Case-insensitive partial match search Example: invoice.
parseur_documents_listList the documents in a Parseur mailbox, with search, status, received-date filters, ordering and paging; optionally include parsed results.Read-onlyList Documents
List the documents in a Parseur mailbox, with search, status, received-date filters, ordering and paging; optionally include parsed results. Returns results[] of documents with id, name, status, received and processed dates (and result when with_result is true), plus count and next link. Use parseur_document_get for one document.
Inputs
idintegerrequired- ID of the Parseur mailbox. Find it with parseur_mailboxes_list. Example: 12345.
orderingstring- Field name to order by (use -prefix for descending) Example: -created.one of
name-namecreated-createdprocessed-processedstatus-status pageinteger- Page number for pagination (default is 1)
page_sizeinteger- Number of results per page (default is 25) Example: 50.
received_afterstring- Filter documents received after this date (yyyy-mm-dd) Example: 2026-11-01.
received_beforestring- Filter documents received before this date (yyyy-mm-dd) Example: 2026-11-16.
searchstring- Case-insensitive partial match search Example: invoice.
statusstring- Filter documents by status Example: INCOMING.one of
INCOMINGANALYZINGPROGRESSPARSEDOKPARSEDKOQUOTAEXCSKIPPEDSPLITEXPORTKOTRANSKOINVALID tzstring- Timezone for date filters (e.g. Asia%2FSingapore). Defaults to UTC. Example: Europe/Paris.
with_resultboolean- Include parsed result string with each document Example: true.
parseur_downloads_listList the custom CSV/Excel downloads (export configurations) of a Parseur mailbox.Read-onlyList Custom Downloads
List the custom CSV/Excel downloads (export configurations) of a Parseur mailbox. Returns the downloads with id, name, type, selected fields and csv_download/xls_download URLs. Use parseur_download_create to add one.
Inputs
idintegerrequired- ID of the Parseur mailbox. Find it with parseur_mailboxes_list. Example: 12345.
parseur_mailbox_getGet one Parseur mailbox with its full settings and fields.Read-onlyGet Mailbox
Get one Parseur mailbox with its full settings and fields. Returns the mailbox: name, email_prefix, AI engine, fields (parser_object_set), processing options, webhooks and download URLs. Use parseur_mailboxes_list to find the ID.
Inputs
idintegerrequired- ID of the Parseur mailbox. Find it with parseur_mailboxes_list. Example: 12345.
parseur_mailbox_schema_getGet the field structure (schema) of a Parseur mailbox's parsed data.Read-onlyGet Mailbox Schema
Get the field structure (schema) of a Parseur mailbox's parsed data. Returns the JSON schema of the fields and tables Parseur extracts. Use to map parsed results to your own system.
Inputs
idintegerrequired- ID of the Parseur mailbox. Find it with parseur_mailboxes_list. Example: 12345.
parseur_mailboxes_listList the Parseur mailboxes (parsers) in the account, with search, ordering and paging.Read-onlyList Mailboxes
List the Parseur mailboxes (parsers) in the account, with search, ordering and paging. Returns results[] of mailboxes with id, name, email_prefix, document and template counts, plus count and next/previous links. Use parseur_mailbox_get for one mailbox's full settings.
Inputs
orderingstring- Field name to order by (use -prefix for descending) Example: -created.one of
name-namedocument_count-document_counttemplate_count-template_countPARSEDOK_count-PARSEDOK_countPARSEDKO_count-PARSEDKO_countQUOTAEXC_count-QUOTAEXC_countEXPORTKO_count-EXPORTKO_countTRANSKO_count-TRANSKO_count pageinteger- Page number for pagination (default is 1)
page_sizeinteger- Number of results per page (default is 25) Example: 50.
searchstring- Case-insensitive partial match search Example: invoice.
parseur_template_getGet one Parseur parsing template.Read-onlyGet Template
Get one Parseur parsing template. Returns the template with name, status, fields and sample document. Use parseur_templates_list to find the ID.
Inputs
idintegerrequired- ID of the template. Example: 4567.
parseur_templates_listList the parsing templates of a Parseur mailbox.Read-onlyList Templates
List the parsing templates of a Parseur mailbox. Returns the templates with id, name, status, document count and dates. Use parseur_template_get for one template.
Inputs
idintegerrequired- ID of the Parseur mailbox. Find it with parseur_mailboxes_list. Example: 12345.
parseur_document_copyCopy a Parseur document into another mailbox, where it is parsed again.WriteCopy Document
Copy a Parseur document into another mailbox, where it is parsed again. Returns the new document. Use parseur_mailboxes_list to find the target mailbox ID.
Inputs
idstringrequired- ID of the document. Find it with parseur_documents_list. Example: 9a1b2c3d4e5f.
target_mailbox_idintegerrequired- ID of the Parseur mailbox. Find it with parseur_mailboxes_list. Example: 12345.
parseur_document_reprocessParse a Parseur document again, for example after changing templates or fields.WriteReprocess Document
Parse a Parseur document again, for example after changing templates or fields. Returns the queued document. Fetch the new result with parseur_document_get.
Inputs
idstringrequired- ID of the document. Find it with parseur_documents_list. Example: 9a1b2c3d4e5f.
parseur_document_skipMark a Parseur document as skipped so it is not parsed or exported.WriteSkip Document
Mark a Parseur document as skipped so it is not parsed or exported. Returns the updated document. Use parseur_document_reprocess to parse it again.
- Idempotent
Inputs
idstringrequired- ID of the document. Find it with parseur_documents_list. Example: 9a1b2c3d4e5f.
parseur_download_createCreate a custom CSV/Excel download for a Parseur mailbox that exports chosen fields.WriteCreate Custom Download
Create a custom CSV/Excel download for a Parseur mailbox that exports chosen fields. Returns the download with its csv_download and xls_download URLs. Get field names from parseur_mailbox_schema_get.
Inputs
idintegerrequired- ID of the Parseur mailbox. Find it with parseur_mailboxes_list. Example: 12345.
itemsarrayrequired- Field names to include, in order. Example: ["CustomerName", "CustomerPhone"].
namestringrequired- Name of the download. Example: My Download.
typestringrequired- PARSER for document-level fields, or PARSER_FIELD for the rows of one table field.one of
PARSERPARSER_FIELD parser_field_idstring- Table field ID (starts with PF); required when type is PARSER_FIELD. Example: PF12345.
parseur_download_updateChange the name, type or fields of a custom download of a Parseur mailbox.WriteUpdate Custom Download
Change the name, type or fields of a custom download of a Parseur mailbox. Returns the updated download. Use parseur_downloads_list to find the download ID.
- Idempotent
Inputs
idstringrequired- ID of the custom download. Example: 678.
mailbox_idintegerrequired- ID of the Parseur mailbox. Find it with parseur_mailboxes_list. Example: 12345.
itemsarray- Field names to include, in order. Example: ["CustomerName", "Total"].
namestring- Name of the download. Example: My Download.
parser_field_idstring- Table field ID (starts with PF) for PARSER_FIELD downloads. Example: PF12345.
typestring- PARSER or PARSER_FIELD.one of
PARSERPARSER_FIELD
parseur_email_createSend an email or text document to a Parseur mailbox for parsing, addressed by the mailbox's Parseur email address.WriteSend Email Document
Send an email or text document to a Parseur mailbox for parsing, addressed by the mailbox's Parseur email address. Returns the creation result; the document is parsed in the background. Fetch the result with parseur_documents_list (with_result) or a webhook.
Inputs
fromstringrequired- Sender email address. Example: shop@example.com.
recipientstringrequired- The mailbox's Parseur email address, which picks the mailbox. Example: acme-invoices@in.parseur.com.
subjectstringrequired- Email subject or document name. Example: Order #1234.
bccstring- BCC header value. Example: archive@example.com.
body_htmlstring- HTML body of the email. Give body_html or body_plain. Example: <p>Order #1234 total $56.00</p>.
body_plainstring- Plain-text body of the email. Example: Order #1234 total $56.00.
ccstring- CC header value. Example: finance@example.com.
message_headersarray- Extra email headers as name/value pairs. Example: [["Reply-To", "support@example.com"]].
tostring- To header value. Example: orders@example.com.
parseur_mailbox_copyDuplicate a Parseur mailbox with its settings, fields and templates.WriteCopy Mailbox
Duplicate a Parseur mailbox with its settings, fields and templates. Returns the new mailbox. Rename it afterwards with parseur_mailbox_update.
Inputs
idintegerrequired- ID of the Parseur mailbox. Find it with parseur_mailboxes_list. Example: 12345.
parseur_mailbox_createCreate a Parseur mailbox, optionally from a ready-made AI template such as invoices.WriteCreate Mailbox
Create a Parseur mailbox, optionally from a ready-made AI template such as invoices. Returns the new mailbox with its id and email address. Send documents to it with parseur_email_create or by email.
Inputs
ai_enginestring- AI engine: DISABLED (template-based parsing only), GCP_AI_2, GCP_AI_3_TXT or GCP_AI_4.one of
DISABLEDGCP_AI_2GCP_AI_3_TXTGCP_AI_4 ai_instructionsstring- General instructions for the AI parser. Example: Dates are in DD/MM/YYYY format.
allowed_extensionsarray- Only process files with these extensions; all extensions when empty. Example: ["pdf", "png"].
attachments_only_overrideboolean- true parses only email attachments and ignores the email body; false parses both.
decimal_separatorstring- Decimal separator used in documents' numbers: . (default) or ,.one of
., default_timezonestring- Default time zone for parsed dates. Example: Europe/Paris.
disable_document_linksboolean- true removes document links (DocumentURL fields) from exported data.
email_prefixstring- Prefix of the mailbox's Parseur email address. Example: acme-invoices.
emails_or_domainsarray- Sender emails or domains to block (or, with use_whitelist_instead_of_blacklist, the only ones to accept). Example: ["supplier.com"].
expand_resultboolean- true expands table fields into separate rows in exported results.
force_ocrboolean- true makes Parseur run its own OCR on every uploaded document, even ones with text.
input_date_formatstring- Whether ambiguous dates in documents put the day first (DAY_FIRST, e.g. 05/11 = 5 November) or the month first (MONTH_FIRST).one of
MONTH_FIRSTDAY_FIRST master_parser_slugstring- Ready-made AI parser template to start from, such as invoices, statements, leads, resume-cv, payslip or travel.one of
invoicesstatementsjob-applicationleadsresume-cvfood-deliverysearch-alertsreal-estatework-orderfinancial-statementutilitycontact-listdelivery-notesproperty-bookingsjob-searchtravelautomotivepayslipevent-ticketing namestring- Name of the mailbox. Example: Invoices.
process_attachmentsboolean- Whether to process email attachments as separate documents.
retention_policyinteger- Days to keep documents and data before deletion (default 90). Example: 30.
split_keywordsobject- Split documents where this keyword appears: keyword is the text, and is_before true starts the new document on the page with the keyword. Example: {"keyword": "Invoice Number", "is_before": true}.
split_pageinteger- Split each uploaded file every N pages; 0 or empty means no split. Example: 1.
use_whitelist_instead_of_blacklistboolean- true treats emails_or_domains as the only senders to accept instead of senders to block.
parseur_mailbox_updateChange a Parseur mailbox's name, AI settings, email prefix, page splitting, retention and other options.WriteUpdate Mailbox
Change a Parseur mailbox's name, AI settings, email prefix, page splitting, retention and other options. Returns the updated mailbox. Use parseur_mailbox_get to read the current settings first.
- Idempotent
Inputs
idintegerrequired- ID of the Parseur mailbox. Find it with parseur_mailboxes_list. Example: 12345.
ai_enginestring- AI engine: DISABLED (template-based parsing only), GCP_AI_2, GCP_AI_3_TXT or GCP_AI_4.one of
DISABLEDGCP_AI_2GCP_AI_3_TXTGCP_AI_4 ai_instructionsstring- General instructions for the AI parser. Example: Dates are in DD/MM/YYYY format.
allowed_extensionsarray- Only process files with these extensions; all extensions when empty. Example: ["pdf", "png"].
attachments_only_overrideboolean- true parses only email attachments and ignores the email body; false parses both.
decimal_separatorstring- Decimal separator used in documents' numbers: . (default) or ,.one of
., default_timezonestring- Default time zone for parsed dates. Example: Europe/Paris.
disable_document_linksboolean- true removes document links (DocumentURL fields) from exported data.
email_prefixstring- Prefix of the mailbox's Parseur email address. Example: acme-invoices.
emails_or_domainsarray- Sender emails or domains to block (or, with use_whitelist_instead_of_blacklist, the only ones to accept). Example: ["supplier.com"].
expand_resultboolean- true expands table fields into separate rows in exported results.
force_ocrboolean- true makes Parseur run its own OCR on every uploaded document, even ones with text.
input_date_formatstring- Whether ambiguous dates in documents put the day first (DAY_FIRST, e.g. 05/11 = 5 November) or the month first (MONTH_FIRST).one of
MONTH_FIRSTDAY_FIRST master_parser_slugstring- Ready-made AI parser template to start from, such as invoices, statements, leads, resume-cv, payslip or travel.one of
invoicesstatementsjob-applicationleadsresume-cvfood-deliverysearch-alertsreal-estatework-orderfinancial-statementutilitycontact-listdelivery-notesproperty-bookingsjob-searchtravelautomotivepayslipevent-ticketing namestring- Name of the mailbox. Example: Invoices.
process_attachmentsboolean- Whether to process email attachments as separate documents.
retention_policyinteger- Days to keep documents and data before deletion (default 90). Example: 30.
split_keywordsobject- Split documents where this keyword appears: keyword is the text, and is_before true starts the new document on the page with the keyword. Example: {"keyword": "Invoice Number", "is_before": true}.
split_pageinteger- Split each uploaded file every N pages; 0 or empty means no split. Example: 1.
use_whitelist_instead_of_blacklistboolean- true treats emails_or_domains as the only senders to accept instead of senders to block.
parseur_mailbox_webhook_enableTurn on a Parseur webhook for a mailbox so its documents are sent to it.WriteEnable Mailbox Webhook
Turn on a Parseur webhook for a mailbox so its documents are sent to it. Returns the mailbox's webhook settings. Create the webhook with parseur_webhook_create first.
- Idempotent
Inputs
idintegerrequired- ID of the webhook. Example: 890.
mailbox_idintegerrequired- ID of the Parseur mailbox. Find it with parseur_mailboxes_list. Example: 12345.
parseur_template_copyCopy a Parseur template into another mailbox.WriteCopy Template
Copy a Parseur template into another mailbox. Returns the new template. Use parseur_mailboxes_list to find the target mailbox ID.
Inputs
idintegerrequired- ID of the template to copy. Example: 4567.
target_mailbox_idintegerrequired- ID of the Parseur mailbox. Find it with parseur_mailboxes_list. Example: 12345.
parseur_webhook_createCreate a Parseur webhook that POSTs parsed data or failures to a URL.WriteCreate Webhook
Create a Parseur webhook that POSTs parsed data or failures to a URL. Returns the new webhook with its id. Attach it to a mailbox with parseur_mailbox_webhook_enable.
Inputs
categorystringrequired- Integration category; use CUSTOM for your own URL.one of
CUSTOMZAPIERMAKEFLOWN8N eventstringrequired- Event to send: document.processed, document.processed.flattened, document.template_needed, document.export_failed or table.processed.one of
document.processeddocument.processed.flatteneddocument.template_neededdocument.export_failedtable.processed targetstringrequired- URL Parseur POSTs to. Example: https://example.com/parseur.
headersobject- Extra HTTP headers to send with each call. Example: {"X-Token": "abc123"}.
namestring- Webhook name. Example: Send to CRM.
parser_field_setarray- Table field IDs to send; only for table.processed. Example: ["PF12345"].
parseur_document_deleteDelete a Parseur document and its parsed data.DestructiveDelete Document
Delete a Parseur document and its parsed data. Returns an empty response. Use parseur_document_skip to keep it but exclude it.
- Idempotent
Inputs
idstringrequired- ID of the document. Find it with parseur_documents_list. Example: 9a1b2c3d4e5f.
parseur_download_deleteDelete a custom download of a Parseur mailbox.DestructiveDelete Custom Download
Delete a custom download of a Parseur mailbox. Its URLs stop working. Returns an empty response. Use parseur_downloads_list to find the ID.
- Idempotent
Inputs
idstringrequired- ID of the custom download. Example: 678.
mailbox_idintegerrequired- ID of the Parseur mailbox. Find it with parseur_mailboxes_list. Example: 12345.
parseur_mailbox_deleteDelete a Parseur mailbox with its documents, templates and settings.DestructiveDelete Mailbox
Delete a Parseur mailbox with its documents, templates and settings. Returns an empty response. Use parseur_mailboxes_list to find the ID.
- Idempotent
Inputs
idintegerrequired- ID of the Parseur mailbox. Find it with parseur_mailboxes_list. Example: 12345.
parseur_mailbox_webhook_disableTurn off a Parseur webhook for a mailbox.DestructiveDisable Mailbox Webhook
Turn off a Parseur webhook for a mailbox. The webhook itself is kept. Returns an empty response. Use parseur_webhook_delete to remove the webhook.
- Idempotent
Inputs
idintegerrequired- ID of the webhook. Example: 890.
mailbox_idintegerrequired- ID of the Parseur mailbox. Find it with parseur_mailboxes_list. Example: 12345.
parseur_template_deleteDelete a Parseur parsing template.DestructiveDelete Template
Delete a Parseur parsing template. Returns an empty response. Use parseur_templates_list to find the ID.
- Idempotent
Inputs
idstringrequired- ID of the template. Example: 4567.
parseur_webhook_deleteDelete a Parseur webhook from the account.DestructiveDelete Webhook
Delete a Parseur webhook from the account. Returns an empty response. Use parseur_mailbox_webhook_disable to stop it for one mailbox only.
- Idempotent
Inputs
idstringrequired- ID of the webhook. Example: 890.
No tools match.