> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# parseur
> Document Parsing API
**Server path:** `/parseur` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ----------------------------------------------------------------------------- | --------------------------- |
| [`parseur_copy_document`](#parseur_copy_document) | Copy a document |
| [`parseur_copy_parser`](#parseur_copy_parser) | Copy a mailbox |
| [`parseur_copy_template`](#parseur_copy_template) | Copy a template |
| [`parseur_create_parser`](#parseur_create_parser) | Create a mailbox |
| [`parseur_create_parser_export_config`](#parseur_create_parser_export_config) | Create a custom download |
| [`parseur_create_parser_webhook_set`](#parseur_create_parser_webhook_set) | Enable a webhook |
| [`parseur_create_webhook`](#parseur_create_webhook) | Create a webhook |
| [`parseur_delete_document`](#parseur_delete_document) | Delete a document |
| [`parseur_delete_parser`](#parseur_delete_parser) | Delete a mailbox |
| [`parseur_delete_parser_export_config`](#parseur_delete_parser_export_config) | Delete a custom download |
| [`parseur_delete_parser_webhook_set`](#parseur_delete_parser_webhook_set) | Disable a webhook |
| [`parseur_delete_template`](#parseur_delete_template) | Delete a template |
| [`parseur_delete_webhook`](#parseur_delete_webhook) | Delete a webhook |
| [`parseur_get_document`](#parseur_get_document) | Get a document |
| [`parseur_get_document_log_set`](#parseur_get_document_log_set) | Get document logs |
| [`parseur_get_parser`](#parseur_get_parser) | Get a mailbox |
| [`parseur_get_parser_document_set`](#parseur_get_parser_document_set) | List documents in a mailbox |
| [`parseur_get_parser_export_config`](#parseur_get_parser_export_config) | List custom downloads |
| [`parseur_get_parser_schema`](#parseur_get_parser_schema) | Get mailbox schema |
| [`parseur_get_parser_template_set`](#parseur_get_parser_template_set) | List templates in a mailbox |
| [`parseur_get_template`](#parseur_get_template) | Get a template |
| [`parseur_list_parser`](#parseur_list_parser) | List mailboxes |
| [`parseur_process_document`](#parseur_process_document) | Reprocess a document |
| [`parseur_skip_document`](#parseur_skip_document) | Skip a document |
| [`parseur_update_parser`](#parseur_update_parser) | Update a mailbox |
| [`parseur_update_parser_export_config`](#parseur_update_parser_export_config) | Update a custom download |
| [`parseur_upload_parser`](#parseur_upload_parser) | Upload a binary document |
***
## parseur\_copy\_document
Copy a document
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------ | -------- | ------- | ----------------- |
| `id` | string | Yes | — | The id value |
| `target_mailbox_id` | string | Yes | — | Target Mailbox Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"target_mailbox_id": {
"type": "string",
"description": "Target Mailbox Id"
}
},
"required": [
"PCID",
"id",
"target_mailbox_id"
]
}
```
***
## parseur\_copy\_parser
Copy a mailbox
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------ |
| `id` | integer | Yes | — | The id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## parseur\_copy\_template
Copy a template
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | ----------------- |
| `id` | integer | Yes | — | The id value |
| `target_mailbox_id` | integer | Yes | — | Target Mailbox Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
},
"target_mailbox_id": {
"type": "integer",
"description": "Target Mailbox Id"
}
},
"required": [
"PCID",
"id",
"target_mailbox_id"
]
}
```
***
## parseur\_create\_parser
Create a mailbox
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `account_uuid` | string | Yes | — | The Universally Unique Identifier for your account. | |
| `ai_engine` | string | No | — | Ai Engine | |
| `ai_instructions` | string | null | No | — | General AI instruction for this parser. |
| `allowed_extensions` | string\[] | No | — | List of files extensions to process. If not present, all extensions will be enabled. | |
| `attachments_field` | boolean | No | — | Whether the Attachments metadata field is enabled for this parser. | |
| `attachments_only` | boolean | Yes | — | Whether the parser in question skips email processing or not (read-only). | |
| `attachments_only_override` | boolean | null | No | — | Use this to update attachments\_only. |
| `available_webhook_set` | object\[] | No | — | Available Webhook Set | |
| `bcc_field` | boolean | No | — | Whether the BCC metadata field is enabled for this parser. | |
| `can_transform` | boolean | No | — | Whether Python Post-Processing is enabled for this parser. | |
| `cc_field` | boolean | No | — | Whether the CC metadata field is enabled for this parser. | |
| `content_field` | boolean | No | — | Whether the Content metadata field is enabled for this parser. | |
| `credit_count_field` | boolean | No | — | Whether the CreditCount metadata field is enabled for this parser. | |
| `csv_download` | string | No | — | Csv Download | |
| `decimal_separator` | string | null | No | — | Decimal Separator |
| `default_timezone` | string | null | No | — | Default Timezone |
| `disable_deskew` | boolean | No | — | Whether deskew is disabled for this parser (enabled by default). | |
| `disable_document_links` | boolean | No | — | Disable Document Links | |
| `document_count` | integer | No | — | The number of documents in the parser. | |
| `document_id_field` | boolean | No | — | Whether the DocumentID metadata field is enabled for this parser. | |
| `document_per_status_count` | object | No | — | This is a breakdown of the documents in the parser by status. | |
| `document_url_field` | boolean | No | — | Whether the DocumentURL metadata field is enabled for this parser. | |
| `email_prefix` | string | No | — | The email prefix for the parser. | |
| `emails_or_domains` | any\[] | No | — | Emails Or Domains | |
| `enable_layouted_text` | boolean | No | — | Enable Layouted Text | |
| `even_pages` | boolean | No | — | Whether the parser is configured to process only even page numbers in a document. | |
| `expand_result` | boolean | No | — | Expand Result | |
| `extract_xml_from_comment` | boolean | No | — | Extract Xml From Comment | |
| `force_ocr` | boolean | No | — | Whether Parseur runs its own OCR on every document uploaded to this parser. | |
| `headers_field` | boolean | No | — | Whether the Headers metadata field is enabled for this parser. | |
| `html_document_field` | boolean | No | — | Whether the HTMLDocument metadata field is enabled for this parser. | |
| `id` | integer | No | — | The internal ID number for the parser. | |
| `identification_status` | string | null | No | — | Identification Status |
| `input_date_format` | string | null | No | — | Input Date Format |
| `is_master` | boolean | Yes | — | Whether this is a master parser that passes its instructions on to others. | |
| `is_transform_enabled` | boolean | No | — | Is Transform Enabled | |
| `json_download` | string | No | — | Json Download | |
| `last_activity` | string | No | — | Last Activity | |
| `last_reply_field` | boolean | No | — | Whether the LastReply metadata field is enabled for this parser. | |
| `mailbox_id_field` | boolean | No | — | Whether the MailboxID metadata field is enabled for this parser. | |
| `master_parser_name` | string | No | — | The name of this parser's master parser. | |
| `master_parser_slug` | string | null | No | — | Master Parser Slug |
| `name` | string | No | — | The name of the parser. | |
| `odd_pages` | boolean | No | — | Whether the parser is configured to process only odd page numbers in a document. | |
| `original_document_field` | boolean | No | — | Whether the OriginalDocument metadata field is enabled for this parser. | |
| `original_recipient_field` | boolean | No | — | Whether the OriginalRecipient metadata field is enabled for this parser. | |
| `page_count_field` | boolean | No | — | Whether the PageCount metadata field is enabled for this parser. | |
| `page_range_set` | object\[] | No | — | The range of pages set to be processed in the parser. | |
| `parent_id_field` | boolean | No | — | Whether the ParentID metadata field is enabled for this parser. | |
| `parser_object_count` | integer | No | — | The total number of field and metadata outputs currently configured in the parser. | |
| `parser_object_set` | object\[] | No | — | The list of fields in a parser. | |
| `parser_object_set_last_modified` | string | No | — | Parser Object Set Last Modified | |
| `parsing_engine_field` | boolean | No | — | Whether the ParsingEngine metadata field is enabled for this parser. | |
| `pdf_conversion_format` | string | No | — | Pdf Conversion Format | |
| `process_attachments` | boolean | No | — | Whether email attachment processing is enabled on this parser. | |
| `processed_date_field` | boolean | No | — | Whether the ProcessedDate metadata field is enabled for this parser. | |
| `processed_field` | boolean | No | — | Whether the Processed metadata field is enabled for this parser. | |
| `processed_time_field` | boolean | No | — | Whether the ProcessedTime metadata field is enabled for this parser. | |
| `public_document_url_field` | boolean | No | — | Whether the PublicDocumentURL metadata field is enabled for this parser. | |
| `received_date_field` | boolean | No | — | Whether the ReceivedDate metadata field is enabled for this parser. | |
| `received_field` | boolean | No | — | Whether the Received metadata field is enabled for this parser. | |
| `received_time_field` | boolean | No | — | Whether the ReceivedTime metadata field is enabled for this parser. | |
| `recipient_field` | boolean | No | — | Whether the Recipient metadata field is enabled for this parser. | |
| `recipient_suffix_field` | boolean | No | — | Whether the RecipientSuffix metadata field is enabled for this parser. | |
| `reply_to_field` | boolean | No | — | Whether the ReplyTo metadata field is enabled for this parser. | |
| `retention_policy` | integer | No | — | How many days documents and data are stored on our servers before deletion (90 days is the detaulf). | |
| `searchable_pdf_field` | boolean | No | — | Whether the SearchablePDF metadata field is enabled for this parser. | |
| `secret` | string | No | — | The secret value | |
| `sender_field` | boolean | No | — | Whether the Sender metadata field is enabled for this parser. | |
| `sender_name_field` | boolean | No | — | Whether the SenderName metadata field is enabled for this parser. | |
| `split_keywords` | object | No | — | The keyword(s) the parser will look for when splitting documents by page. | |
| `split_page` | integer | null | No | — | If not 0, this is the number of pages the parser will use to split in a file uploaded to this parser. If set to three, the parser will split a 30 page document 10 times, resulting in 10 files. |
| `split_page_range_field` | boolean | No | — | Whether the SplitPageRange metadata field is enabled for this parser. | |
| `split_page_range_set` | object\[] | No | — | The specific page ranges set to be captured in this parser. Can have multiple values, i.e. 1,3-5,(1) | |
| `subject_field` | boolean | No | — | Whether the Subject metadata field is enabled for this parser. | |
| `table_set` | object\[] | No | — | Table Set | |
| `template_count` | integer | No | — | The number of templates the parser has. | |
| `template_field` | boolean | No | — | Whether the Template metadata field is enabled for this parser. | |
| `template_set_last_modified` | string | null | No | — | Template Set Last Modified |
| `text_document_field` | boolean | No | — | Whether the TextDocument metadata field is enabled for this parser. | |
| `to_field` | boolean | No | — | Whether the To metadata field is enabled for this parser. | |
| `transform` | string | null | No | — | The transform value |
| `use_whitelist_instead_of_blacklist` | boolean | No | — | Use Whitelist Instead Of Blacklist | |
| `webhook_count` | integer | No | — | The number of webhooks the parser has. | |
| `webhook_set` | object\[] | No | — | Webhook Set | |
| `xls_download` | string | No | — | Xls Download | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_uuid": {
"type": "string",
"description": "The Universally Unique Identifier for your account."
},
"ai_engine": {
"type": "string",
"description": "Ai Engine",
"enum": [
"DISABLED",
"GCP_AI_1",
"GCP_AI_2",
"GCP_AI_2_5"
]
},
"ai_instructions": {
"type": [
"string",
"null"
],
"description": "General AI instruction for this parser."
},
"allowed_extensions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"bmp",
"csv",
"doc",
"docx",
"eml",
"gif",
"html",
"ics",
"jpg",
"mbox",
"msg",
"ods",
"odt",
"pdf",
"png",
"rtf",
"tif",
"txt",
"xhtml",
"xls",
"xlsm",
"xlsx",
"xml",
"zip"
]
},
"description": "List of files extensions to process. If not present, all extensions will be enabled."
},
"attachments_field": {
"type": "boolean",
"description": "Whether the Attachments metadata field is enabled for this parser."
},
"attachments_only": {
"type": "boolean",
"description": "Whether the parser in question skips email processing or not (read-only)."
},
"attachments_only_override": {
"type": [
"boolean",
"null"
],
"description": "Use this to update attachments_only."
},
"available_webhook_set": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The id value"
},
"event": {
"type": "string",
"enum": [
"document.processed",
"document.processed.flattened",
"document.template_needed",
"document.export_failed",
"table.processed"
],
"description": "The event value"
},
"target": {
"type": "string",
"format": "uri",
"description": "The target value"
},
"name": {
"type": "string",
"description": "The name value"
},
"headers": {
"type": "object",
"description": "The headers value"
},
"category": {
"type": "string",
"enum": [
"CUSTOM",
"ZAPIER",
"MAKE",
"FLOW",
"N8N"
],
"description": "The category value"
},
"parser_field_set": {
"type": "array",
"items": {
"type": "string"
},
"description": "Only for table.processed events"
}
},
"required": [
"id",
"event",
"target",
"category"
]
},
"description": "Available Webhook Set"
},
"bcc_field": {
"type": "boolean",
"description": "Whether the BCC metadata field is enabled for this parser."
},
"can_transform": {
"type": "boolean",
"description": "Whether Python Post-Processing is enabled for this parser."
},
"cc_field": {
"type": "boolean",
"description": "Whether the CC metadata field is enabled for this parser."
},
"content_field": {
"type": "boolean",
"description": "Whether the Content metadata field is enabled for this parser."
},
"credit_count_field": {
"type": "boolean",
"description": "Whether the CreditCount metadata field is enabled for this parser."
},
"csv_download": {
"type": "string",
"description": "Csv Download"
},
"decimal_separator": {
"type": [
"string",
"null"
],
"description": "Decimal Separator",
"enum": [
".",
","
]
},
"default_timezone": {
"type": [
"string",
"null"
],
"description": "Default Timezone"
},
"disable_deskew": {
"type": "boolean",
"description": "Whether deskew is disabled for this parser (enabled by default)."
},
"disable_document_links": {
"type": "boolean",
"description": "Disable Document Links"
},
"document_count": {
"type": "integer",
"description": "The number of documents in the parser."
},
"document_id_field": {
"type": "boolean",
"description": "Whether the DocumentID metadata field is enabled for this parser."
},
"document_per_status_count": {
"type": "object",
"description": "This is a breakdown of the documents in the parser by status.",
"properties": {
"INCOMING": {
"type": "integer",
"description": "Files that have been received by our system but are awaiting processing."
},
"ANALYZING": {
"type": "integer",
"description": "Files being analyzed against our system's import parameters and the user's mailbox settings."
},
"PROGRESS": {
"type": "integer",
"description": "Files currently being processed by active AI engine for that mailbox."
},
"PARSEDOK": {
"type": "integer",
"description": "Files that have been processed and data is available for export."
},
"PARSEDKO": {
"type": "integer",
"description": "Files where processing failed."
},
"QUOTAEXC": {
"type": "integer",
"description": "Files where processing was stopped because the user does not have enough credits to process them."
},
"SKIPPED": {
"type": "integer",
"description": "Files that were skipped because of a template."
},
"SPLIT": {
"type": "integer",
"description": "Files that were split into multiple documents."
},
"EXPORTKO": {
"type": "integer",
"description": "Files where exporting the parsed data failed."
},
"TRANSKO": {
"type": "integer",
"description": "Files where our Python post-processing failed to process."
},
"INVALID": {
"type": "integer",
"description": "Files that were not processed because they are not supported by our system."
}
},
"required": [
"INCOMING",
"ANALYZING",
"PROGRESS",
"PARSEDOK",
"PARSEDKO",
"QUOTAEXC",
"SKIPPED",
"SPLIT",
"EXPORTKO",
"TRANSKO",
"INVALID"
]
},
"document_url_field": {
"type": "boolean",
"description": "Whether the DocumentURL metadata field is enabled for this parser."
},
"email_prefix": {
"type": "string",
"description": "The email prefix for the parser."
},
"emails_or_domains": {
"type": "array",
"description": "Emails Or Domains"
},
"enable_layouted_text": {
"type": "boolean",
"description": "Enable Layouted Text"
},
"even_pages": {
"type": "boolean",
"description": "Whether the parser is configured to process only even page numbers in a document."
},
"expand_result": {
"type": "boolean",
"description": "Expand Result"
},
"extract_xml_from_comment": {
"type": "boolean",
"description": "Extract Xml From Comment"
},
"force_ocr": {
"type": "boolean",
"description": "Whether Parseur runs its own OCR on every document uploaded to this parser."
},
"headers_field": {
"type": "boolean",
"description": "Whether the Headers metadata field is enabled for this parser."
},
"html_document_field": {
"type": "boolean",
"description": "Whether the HTMLDocument metadata field is enabled for this parser."
},
"id": {
"type": "integer",
"description": "The internal ID number for the parser."
},
"identification_status": {
"type": [
"string",
"null"
],
"description": "Identification Status",
"enum": [
"REQUESTED",
"PROGRESS",
"COMPLETED",
"MANUAL"
]
},
"input_date_format": {
"type": [
"string",
"null"
],
"description": "Input Date Format",
"enum": [
"MONTH_FIRST",
"DAY_FIRST"
]
},
"is_master": {
"type": "boolean",
"description": "Whether this is a master parser that passes its instructions on to others."
},
"is_transform_enabled": {
"type": "boolean",
"description": "Is Transform Enabled"
},
"json_download": {
"type": "string",
"description": "Json Download"
},
"last_activity": {
"type": "string",
"description": "Last Activity"
},
"last_reply_field": {
"type": "boolean",
"description": "Whether the LastReply metadata field is enabled for this parser."
},
"mailbox_id_field": {
"type": "boolean",
"description": "Whether the MailboxID metadata field is enabled for this parser."
},
"master_parser_name": {
"type": "string",
"description": "The name of this parser's master parser."
},
"master_parser_slug": {
"type": [
"string",
"null"
],
"description": "Master Parser Slug",
"enum": [
"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"
]
},
"name": {
"type": "string",
"description": "The name of the parser."
},
"odd_pages": {
"type": "boolean",
"description": "Whether the parser is configured to process only odd page numbers in a document."
},
"original_document_field": {
"type": "boolean",
"description": "Whether the OriginalDocument metadata field is enabled for this parser."
},
"original_recipient_field": {
"type": "boolean",
"description": "Whether the OriginalRecipient metadata field is enabled for this parser."
},
"page_count_field": {
"type": "boolean",
"description": "Whether the PageCount metadata field is enabled for this parser."
},
"page_range_set": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start_index": {
"type": "integer",
"description": "Start Index"
},
"end_index": {
"type": "integer",
"description": "End Index"
}
},
"required": [
"start_index",
"end_index"
]
},
"description": "The range of pages set to be processed in the parser."
},
"parent_id_field": {
"type": "boolean",
"description": "Whether the ParentID metadata field is enabled for this parser."
},
"parser_object_count": {
"type": "integer",
"description": "The total number of field and metadata outputs currently configured in the parser."
},
"parser_object_set": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"name": {
"type": "string",
"description": "The name value"
},
"format": {
"type": "string",
"enum": [
"TEXT",
"ONELINE",
"DATE",
"TIME",
"DATETIME",
"NUMBER",
"NAME",
"ADDRESS",
"TABLE",
"LINK"
],
"description": "The format value"
},
"choice_set": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of possible choice values. Only used when format is ONELINE."
},
"is_required": {
"type": "boolean",
"description": "Is Required"
},
"query": {
"type": "string",
"description": "Instructions for AI engine"
},
"json_download": {
"type": "string",
"format": "uri",
"description": "Json Download"
},
"csv_download": {
"type": "string",
"format": "uri",
"description": "Csv Download"
},
"xls_download": {
"type": "string",
"format": "uri",
"description": "Xls Download"
},
"type": {
"type": "string",
"description": "The type value"
},
"parser_object_set": {
"type": "array",
"items": {
"type": "object"
},
"description": "Only for TABLE fields"
},
"used_by_ai": {
"type": "boolean",
"description": "If false, that field will not be extracted by AI engines"
}
},
"required": [
"id",
"name",
"format"
]
},
"description": "The list of fields in a parser."
},
"parser_object_set_last_modified": {
"type": "string",
"description": "Parser Object Set Last Modified"
},
"parsing_engine_field": {
"type": "boolean",
"description": "Whether the ParsingEngine metadata field is enabled for this parser."
},
"pdf_conversion_format": {
"type": "string",
"description": "Pdf Conversion Format"
},
"process_attachments": {
"type": "boolean",
"description": "Whether email attachment processing is enabled on this parser."
},
"processed_date_field": {
"type": "boolean",
"description": "Whether the ProcessedDate metadata field is enabled for this parser."
},
"processed_field": {
"type": "boolean",
"description": "Whether the Processed metadata field is enabled for this parser."
},
"processed_time_field": {
"type": "boolean",
"description": "Whether the ProcessedTime metadata field is enabled for this parser."
},
"public_document_url_field": {
"type": "boolean",
"description": "Whether the PublicDocumentURL metadata field is enabled for this parser."
},
"received_date_field": {
"type": "boolean",
"description": "Whether the ReceivedDate metadata field is enabled for this parser."
},
"received_field": {
"type": "boolean",
"description": "Whether the Received metadata field is enabled for this parser."
},
"received_time_field": {
"type": "boolean",
"description": "Whether the ReceivedTime metadata field is enabled for this parser."
},
"recipient_field": {
"type": "boolean",
"description": "Whether the Recipient metadata field is enabled for this parser."
},
"recipient_suffix_field": {
"type": "boolean",
"description": "Whether the RecipientSuffix metadata field is enabled for this parser."
},
"reply_to_field": {
"type": "boolean",
"description": "Whether the ReplyTo metadata field is enabled for this parser."
},
"retention_policy": {
"type": "integer",
"description": "How many days documents and data are stored on our servers before deletion (90 days is the detaulf)."
},
"searchable_pdf_field": {
"type": "boolean",
"description": "Whether the SearchablePDF metadata field is enabled for this parser."
},
"secret": {
"type": "string",
"description": "The secret value"
},
"sender_field": {
"type": "boolean",
"description": "Whether the Sender metadata field is enabled for this parser."
},
"sender_name_field": {
"type": "boolean",
"description": "Whether the SenderName metadata field is enabled for this parser."
},
"split_keywords": {
"type": "object",
"description": "The keyword(s) the parser will look for when splitting documents by page.",
"properties": {
"keyword": {
"type": "string",
"description": "The keyword value"
},
"is_before": {
"type": "boolean",
"description": "Is Before"
}
},
"required": [
"keyword",
"is_before"
]
},
"split_page": {
"type": [
"integer",
"null"
],
"description": "If not 0, this is the number of pages the parser will use to split in a file uploaded to this parser. If set to three, the parser will split a 30 page document 10 times, resulting in 10 files."
},
"split_page_range_field": {
"type": "boolean",
"description": "Whether the SplitPageRange metadata field is enabled for this parser."
},
"split_page_range_set": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start_index": {
"type": "integer",
"description": "Start Index"
},
"end_index": {
"type": "integer",
"description": "End Index"
}
},
"required": [
"start_index",
"end_index"
]
},
"description": "The specific page ranges set to be captured in this parser. Can have multiple values, i.e. 1,3-5,(1)"
},
"subject_field": {
"type": "boolean",
"description": "Whether the Subject metadata field is enabled for this parser."
},
"table_set": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"id",
"name"
]
},
"description": "Table Set"
},
"template_count": {
"type": "integer",
"description": "The number of templates the parser has."
},
"template_field": {
"type": "boolean",
"description": "Whether the Template metadata field is enabled for this parser."
},
"template_set_last_modified": {
"type": [
"string",
"null"
],
"description": "Template Set Last Modified"
},
"text_document_field": {
"type": "boolean",
"description": "Whether the TextDocument metadata field is enabled for this parser."
},
"to_field": {
"type": "boolean",
"description": "Whether the To metadata field is enabled for this parser."
},
"transform": {
"type": [
"string",
"null"
],
"description": "The transform value"
},
"use_whitelist_instead_of_blacklist": {
"type": "boolean",
"description": "Use Whitelist Instead Of Blacklist"
},
"webhook_count": {
"type": "integer",
"description": "The number of webhooks the parser has."
},
"webhook_set": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The id value"
},
"event": {
"type": "string",
"enum": [
"document.processed",
"document.processed.flattened",
"document.template_needed",
"document.export_failed",
"table.processed"
],
"description": "The event value"
},
"target": {
"type": "string",
"format": "uri",
"description": "The target value"
},
"name": {
"type": "string",
"description": "The name value"
},
"headers": {
"type": "object",
"description": "The headers value"
},
"category": {
"type": "string",
"enum": [
"CUSTOM",
"ZAPIER",
"MAKE",
"FLOW",
"N8N"
],
"description": "The category value"
},
"parser_field_set": {
"type": "array",
"items": {
"type": "string"
},
"description": "Only for table.processed events"
}
},
"required": [
"id",
"event",
"target",
"category"
]
},
"description": "Webhook Set"
},
"xls_download": {
"type": "string",
"description": "Xls Download"
}
},
"required": [
"PCID",
"account_uuid",
"attachments_only",
"is_master"
]
}
```
***
## parseur\_create\_parser\_export\_config
Create a custom download
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ----------------- | --------- | -------- | ------- | --------------- | -------------------------------- |
| `id` | string | Yes | — | The id value | |
| `items` | string\[] | Yes | — | The items value | |
| `name` | string | null | Yes | — | Download name |
| `parser_field_id` | string | null | No | — | Parser field ID starting with PF |
| `type` | string | Yes | — | The type value | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"items": {
"type": "array",
"items": {
"type": "string"
},
"description": "The items value"
},
"name": {
"type": [
"string",
"null"
],
"description": "Download name"
},
"parser_field_id": {
"type": [
"string",
"null"
],
"description": "Parser field ID starting with PF"
},
"type": {
"type": "string",
"description": "The type value",
"enum": [
"PARSER",
"PARSER_FIELD"
]
}
},
"required": [
"PCID",
"id",
"items",
"name",
"type"
]
}
```
***
## parseur\_create\_parser\_webhook\_set
Enable a webhook
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------ |
| `mailbox_id` | integer | Yes | — | Mailbox Id |
| `id` | integer | Yes | — | The id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"mailbox_id": {
"type": "integer",
"description": "Mailbox Id"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"mailbox_id",
"id"
]
}
```
***
## parseur\_create\_webhook
Create a webhook
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | --------- | -------- | ------- | ------------------------------- |
| `category` | string | Yes | — | The category value |
| `event` | string | Yes | — | The event value |
| `headers` | object | No | — | The headers value |
| `id` | integer | Yes | — | The id value |
| `name` | string | No | — | The name value |
| `parser_field_set` | string\[] | No | — | Only for table.processed events |
| `target` | string | Yes | — | The target value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"category": {
"type": "string",
"description": "The category value",
"enum": [
"CUSTOM",
"ZAPIER",
"MAKE",
"FLOW",
"N8N"
]
},
"event": {
"type": "string",
"description": "The event value",
"enum": [
"document.processed",
"document.processed.flattened",
"document.template_needed",
"document.export_failed",
"table.processed"
]
},
"headers": {
"type": "object",
"description": "The headers value"
},
"id": {
"type": "integer",
"description": "The id value"
},
"name": {
"type": "string",
"description": "The name value"
},
"parser_field_set": {
"type": "array",
"items": {
"type": "string"
},
"description": "Only for table.processed events"
},
"target": {
"type": "string",
"description": "The target value"
}
},
"required": [
"PCID",
"category",
"event",
"id",
"target"
]
}
```
***
## parseur\_delete\_document
Delete a document
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------ |
| `id` | string | Yes | — | The id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## parseur\_delete\_parser
Delete a mailbox
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------ |
| `id` | integer | Yes | — | The id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## parseur\_delete\_parser\_export\_config
Delete a custom download
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ------------ |
| `mailbox_id` | string | Yes | — | Mailbox Id |
| `id` | string | Yes | — | The id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"mailbox_id": {
"type": "string",
"description": "Mailbox Id"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"mailbox_id",
"id"
]
}
```
***
## parseur\_delete\_parser\_webhook\_set
Disable a webhook
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------ |
| `mailbox_id` | integer | Yes | — | Mailbox Id |
| `id` | integer | Yes | — | The id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"mailbox_id": {
"type": "integer",
"description": "Mailbox Id"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"mailbox_id",
"id"
]
}
```
***
## parseur\_delete\_template
Delete a template
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------ |
| `id` | string | Yes | — | The id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## parseur\_delete\_webhook
Delete a webhook
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------ |
| `id` | string | Yes | — | The id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## parseur\_get\_document
Get a document
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------ |
| `id` | string | Yes | — | The id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## parseur\_get\_document\_log\_set
Get document logs
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | --------------------------------------------------- |
| `id` | string | Yes | — | The id value |
| `page` | integer | No | — | Page number for pagination (default is 1) |
| `page_size` | integer | No | — | Number of results per page (default is 25) |
| `search` | string | No | — | Case-insensitive partial match search |
| `ordering` | string | No | — | Field name to order by (use -prefix for descending) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"page": {
"type": "integer",
"description": "Page number for pagination (default is 1)"
},
"page_size": {
"type": "integer",
"description": "Number of results per page (default is 25)"
},
"search": {
"type": "string",
"description": "Case-insensitive partial match search"
},
"ordering": {
"type": "string",
"description": "Field name to order by (use -prefix for descending)"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## parseur\_get\_parser
Get a mailbox
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------ |
| `id` | integer | Yes | — | The id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## parseur\_get\_parser\_document\_set
List documents in a mailbox
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------- |
| `id` | string | Yes | — | The id value |
| `page` | integer | No | — | Page number for pagination (default is 1) |
| `page_size` | integer | No | — | Number of results per page (default is 25) |
| `search` | string | No | — | Case-insensitive partial match search |
| `ordering` | string | No | — | Field name to order by (use -prefix for descending) |
| `received_after` | string | No | — | Filter documents received after this date (yyyy-mm-dd) |
| `received_before` | string | No | — | Filter documents received before this date (yyyy-mm-dd) |
| `status` | string | No | — | Filter documents by status |
| `tz` | string | No | — | Timezone for date filters (e.g. Asia%2FSingapore). Defaults to UTC. |
| `with_result` | boolean | No | — | Include parsed result string with each document |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"page": {
"type": "integer",
"description": "Page number for pagination (default is 1)"
},
"page_size": {
"type": "integer",
"description": "Number of results per page (default is 25)"
},
"search": {
"type": "string",
"description": "Case-insensitive partial match search"
},
"ordering": {
"type": "string",
"description": "Field name to order by (use -prefix for descending)",
"enum": [
"name",
"-name",
"created",
"-created",
"processed",
"-processed",
"status",
"-status"
]
},
"received_after": {
"type": "string",
"description": "Filter documents received after this date (yyyy-mm-dd)"
},
"received_before": {
"type": "string",
"description": "Filter documents received before this date (yyyy-mm-dd)"
},
"status": {
"type": "string",
"description": "Filter documents by status",
"enum": [
"INCOMING",
"ANALYZING",
"PROGRESS",
"PARSEDOK",
"PARSEDKO",
"QUOTAEXC",
"SKIPPED",
"SPLIT",
"EXPORTKO",
"TRANSKO",
"INVALID"
]
},
"tz": {
"type": "string",
"description": "Timezone for date filters (e.g. Asia%2FSingapore). Defaults to UTC."
},
"with_result": {
"type": "boolean",
"description": "Include parsed result string with each document"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## parseur\_get\_parser\_export\_config
List custom downloads
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------ |
| `id` | string | Yes | — | The id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## parseur\_get\_parser\_schema
Get mailbox schema
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------ |
| `id` | integer | Yes | — | The id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## parseur\_get\_parser\_template\_set
List templates in a mailbox
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id` | integer | Yes | — | The id value | |
| `account_uuid` | string | Yes | — | The Universally Unique Identifier for your account. | |
| `ai_engine` | string | No | — | Ai Engine | |
| `ai_instructions` | string | null | No | — | General AI instruction for this parser. |
| `allowed_extensions` | string\[] | No | — | List of files extensions to process. If not present, all extensions will be enabled. | |
| `attachments_field` | boolean | No | — | Whether the Attachments metadata field is enabled for this parser. | |
| `attachments_only` | boolean | Yes | — | Whether the parser in question skips email processing or not (read-only). | |
| `attachments_only_override` | boolean | null | No | — | Use this to update attachments\_only. |
| `available_webhook_set` | object\[] | No | — | Available Webhook Set | |
| `bcc_field` | boolean | No | — | Whether the BCC metadata field is enabled for this parser. | |
| `can_transform` | boolean | No | — | Whether Python Post-Processing is enabled for this parser. | |
| `cc_field` | boolean | No | — | Whether the CC metadata field is enabled for this parser. | |
| `content_field` | boolean | No | — | Whether the Content metadata field is enabled for this parser. | |
| `credit_count_field` | boolean | No | — | Whether the CreditCount metadata field is enabled for this parser. | |
| `csv_download` | string | No | — | Csv Download | |
| `decimal_separator` | string | null | No | — | Decimal Separator |
| `default_timezone` | string | null | No | — | Default Timezone |
| `disable_deskew` | boolean | No | — | Whether deskew is disabled for this parser (enabled by default). | |
| `disable_document_links` | boolean | No | — | Disable Document Links | |
| `document_count` | integer | No | — | The number of documents in the parser. | |
| `document_id_field` | boolean | No | — | Whether the DocumentID metadata field is enabled for this parser. | |
| `document_per_status_count` | object | No | — | This is a breakdown of the documents in the parser by status. | |
| `document_url_field` | boolean | No | — | Whether the DocumentURL metadata field is enabled for this parser. | |
| `email_prefix` | string | No | — | The email prefix for the parser. | |
| `emails_or_domains` | any\[] | No | — | Emails Or Domains | |
| `enable_layouted_text` | boolean | No | — | Enable Layouted Text | |
| `even_pages` | boolean | No | — | Whether the parser is configured to process only even page numbers in a document. | |
| `expand_result` | boolean | No | — | Expand Result | |
| `extract_xml_from_comment` | boolean | No | — | Extract Xml From Comment | |
| `force_ocr` | boolean | No | — | Whether Parseur runs its own OCR on every document uploaded to this parser. | |
| `headers_field` | boolean | No | — | Whether the Headers metadata field is enabled for this parser. | |
| `html_document_field` | boolean | No | — | Whether the HTMLDocument metadata field is enabled for this parser. | |
| `identification_status` | string | null | No | — | Identification Status |
| `input_date_format` | string | null | No | — | Input Date Format |
| `is_master` | boolean | Yes | — | Whether this is a master parser that passes its instructions on to others. | |
| `is_transform_enabled` | boolean | No | — | Is Transform Enabled | |
| `json_download` | string | No | — | Json Download | |
| `last_activity` | string | No | — | Last Activity | |
| `last_reply_field` | boolean | No | — | Whether the LastReply metadata field is enabled for this parser. | |
| `mailbox_id_field` | boolean | No | — | Whether the MailboxID metadata field is enabled for this parser. | |
| `master_parser_name` | string | No | — | The name of this parser's master parser. | |
| `master_parser_slug` | string | null | No | — | Master Parser Slug |
| `name` | string | No | — | The name of the parser. | |
| `odd_pages` | boolean | No | — | Whether the parser is configured to process only odd page numbers in a document. | |
| `original_document_field` | boolean | No | — | Whether the OriginalDocument metadata field is enabled for this parser. | |
| `original_recipient_field` | boolean | No | — | Whether the OriginalRecipient metadata field is enabled for this parser. | |
| `page_count_field` | boolean | No | — | Whether the PageCount metadata field is enabled for this parser. | |
| `page_range_set` | object\[] | No | — | The range of pages set to be processed in the parser. | |
| `parent_id_field` | boolean | No | — | Whether the ParentID metadata field is enabled for this parser. | |
| `parser_object_count` | integer | No | — | The total number of field and metadata outputs currently configured in the parser. | |
| `parser_object_set` | object\[] | No | — | The list of fields in a parser. | |
| `parser_object_set_last_modified` | string | No | — | Parser Object Set Last Modified | |
| `parsing_engine_field` | boolean | No | — | Whether the ParsingEngine metadata field is enabled for this parser. | |
| `pdf_conversion_format` | string | No | — | Pdf Conversion Format | |
| `process_attachments` | boolean | No | — | Whether email attachment processing is enabled on this parser. | |
| `processed_date_field` | boolean | No | — | Whether the ProcessedDate metadata field is enabled for this parser. | |
| `processed_field` | boolean | No | — | Whether the Processed metadata field is enabled for this parser. | |
| `processed_time_field` | boolean | No | — | Whether the ProcessedTime metadata field is enabled for this parser. | |
| `public_document_url_field` | boolean | No | — | Whether the PublicDocumentURL metadata field is enabled for this parser. | |
| `received_date_field` | boolean | No | — | Whether the ReceivedDate metadata field is enabled for this parser. | |
| `received_field` | boolean | No | — | Whether the Received metadata field is enabled for this parser. | |
| `received_time_field` | boolean | No | — | Whether the ReceivedTime metadata field is enabled for this parser. | |
| `recipient_field` | boolean | No | — | Whether the Recipient metadata field is enabled for this parser. | |
| `recipient_suffix_field` | boolean | No | — | Whether the RecipientSuffix metadata field is enabled for this parser. | |
| `reply_to_field` | boolean | No | — | Whether the ReplyTo metadata field is enabled for this parser. | |
| `retention_policy` | integer | No | — | How many days documents and data are stored on our servers before deletion (90 days is the detaulf). | |
| `searchable_pdf_field` | boolean | No | — | Whether the SearchablePDF metadata field is enabled for this parser. | |
| `secret` | string | No | — | The secret value | |
| `sender_field` | boolean | No | — | Whether the Sender metadata field is enabled for this parser. | |
| `sender_name_field` | boolean | No | — | Whether the SenderName metadata field is enabled for this parser. | |
| `split_keywords` | object | No | — | The keyword(s) the parser will look for when splitting documents by page. | |
| `split_page` | integer | null | No | — | If not 0, this is the number of pages the parser will use to split in a file uploaded to this parser. If set to three, the parser will split a 30 page document 10 times, resulting in 10 files. |
| `split_page_range_field` | boolean | No | — | Whether the SplitPageRange metadata field is enabled for this parser. | |
| `split_page_range_set` | object\[] | No | — | The specific page ranges set to be captured in this parser. Can have multiple values, i.e. 1,3-5,(1) | |
| `subject_field` | boolean | No | — | Whether the Subject metadata field is enabled for this parser. | |
| `table_set` | object\[] | No | — | Table Set | |
| `template_count` | integer | No | — | The number of templates the parser has. | |
| `template_field` | boolean | No | — | Whether the Template metadata field is enabled for this parser. | |
| `template_set_last_modified` | string | null | No | — | Template Set Last Modified |
| `text_document_field` | boolean | No | — | Whether the TextDocument metadata field is enabled for this parser. | |
| `to_field` | boolean | No | — | Whether the To metadata field is enabled for this parser. | |
| `transform` | string | null | No | — | The transform value |
| `use_whitelist_instead_of_blacklist` | boolean | No | — | Use Whitelist Instead Of Blacklist | |
| `webhook_count` | integer | No | — | The number of webhooks the parser has. | |
| `webhook_set` | object\[] | No | — | Webhook Set | |
| `xls_download` | string | No | — | Xls Download | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
},
"account_uuid": {
"type": "string",
"description": "The Universally Unique Identifier for your account."
},
"ai_engine": {
"type": "string",
"description": "Ai Engine",
"enum": [
"DISABLED",
"GCP_AI_1",
"GCP_AI_2",
"GCP_AI_2_5"
]
},
"ai_instructions": {
"type": [
"string",
"null"
],
"description": "General AI instruction for this parser."
},
"allowed_extensions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"bmp",
"csv",
"doc",
"docx",
"eml",
"gif",
"html",
"ics",
"jpg",
"mbox",
"msg",
"ods",
"odt",
"pdf",
"png",
"rtf",
"tif",
"txt",
"xhtml",
"xls",
"xlsm",
"xlsx",
"xml",
"zip"
]
},
"description": "List of files extensions to process. If not present, all extensions will be enabled."
},
"attachments_field": {
"type": "boolean",
"description": "Whether the Attachments metadata field is enabled for this parser."
},
"attachments_only": {
"type": "boolean",
"description": "Whether the parser in question skips email processing or not (read-only)."
},
"attachments_only_override": {
"type": [
"boolean",
"null"
],
"description": "Use this to update attachments_only."
},
"available_webhook_set": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The id value"
},
"event": {
"type": "string",
"enum": [
"document.processed",
"document.processed.flattened",
"document.template_needed",
"document.export_failed",
"table.processed"
],
"description": "The event value"
},
"target": {
"type": "string",
"format": "uri",
"description": "The target value"
},
"name": {
"type": "string",
"description": "The name value"
},
"headers": {
"type": "object",
"description": "The headers value"
},
"category": {
"type": "string",
"enum": [
"CUSTOM",
"ZAPIER",
"MAKE",
"FLOW",
"N8N"
],
"description": "The category value"
},
"parser_field_set": {
"type": "array",
"items": {
"type": "string"
},
"description": "Only for table.processed events"
}
},
"required": [
"id",
"event",
"target",
"category"
]
},
"description": "Available Webhook Set"
},
"bcc_field": {
"type": "boolean",
"description": "Whether the BCC metadata field is enabled for this parser."
},
"can_transform": {
"type": "boolean",
"description": "Whether Python Post-Processing is enabled for this parser."
},
"cc_field": {
"type": "boolean",
"description": "Whether the CC metadata field is enabled for this parser."
},
"content_field": {
"type": "boolean",
"description": "Whether the Content metadata field is enabled for this parser."
},
"credit_count_field": {
"type": "boolean",
"description": "Whether the CreditCount metadata field is enabled for this parser."
},
"csv_download": {
"type": "string",
"description": "Csv Download"
},
"decimal_separator": {
"type": [
"string",
"null"
],
"description": "Decimal Separator",
"enum": [
".",
","
]
},
"default_timezone": {
"type": [
"string",
"null"
],
"description": "Default Timezone"
},
"disable_deskew": {
"type": "boolean",
"description": "Whether deskew is disabled for this parser (enabled by default)."
},
"disable_document_links": {
"type": "boolean",
"description": "Disable Document Links"
},
"document_count": {
"type": "integer",
"description": "The number of documents in the parser."
},
"document_id_field": {
"type": "boolean",
"description": "Whether the DocumentID metadata field is enabled for this parser."
},
"document_per_status_count": {
"type": "object",
"description": "This is a breakdown of the documents in the parser by status.",
"properties": {
"INCOMING": {
"type": "integer",
"description": "Files that have been received by our system but are awaiting processing."
},
"ANALYZING": {
"type": "integer",
"description": "Files being analyzed against our system's import parameters and the user's mailbox settings."
},
"PROGRESS": {
"type": "integer",
"description": "Files currently being processed by active AI engine for that mailbox."
},
"PARSEDOK": {
"type": "integer",
"description": "Files that have been processed and data is available for export."
},
"PARSEDKO": {
"type": "integer",
"description": "Files where processing failed."
},
"QUOTAEXC": {
"type": "integer",
"description": "Files where processing was stopped because the user does not have enough credits to process them."
},
"SKIPPED": {
"type": "integer",
"description": "Files that were skipped because of a template."
},
"SPLIT": {
"type": "integer",
"description": "Files that were split into multiple documents."
},
"EXPORTKO": {
"type": "integer",
"description": "Files where exporting the parsed data failed."
},
"TRANSKO": {
"type": "integer",
"description": "Files where our Python post-processing failed to process."
},
"INVALID": {
"type": "integer",
"description": "Files that were not processed because they are not supported by our system."
}
},
"required": [
"INCOMING",
"ANALYZING",
"PROGRESS",
"PARSEDOK",
"PARSEDKO",
"QUOTAEXC",
"SKIPPED",
"SPLIT",
"EXPORTKO",
"TRANSKO",
"INVALID"
]
},
"document_url_field": {
"type": "boolean",
"description": "Whether the DocumentURL metadata field is enabled for this parser."
},
"email_prefix": {
"type": "string",
"description": "The email prefix for the parser."
},
"emails_or_domains": {
"type": "array",
"description": "Emails Or Domains"
},
"enable_layouted_text": {
"type": "boolean",
"description": "Enable Layouted Text"
},
"even_pages": {
"type": "boolean",
"description": "Whether the parser is configured to process only even page numbers in a document."
},
"expand_result": {
"type": "boolean",
"description": "Expand Result"
},
"extract_xml_from_comment": {
"type": "boolean",
"description": "Extract Xml From Comment"
},
"force_ocr": {
"type": "boolean",
"description": "Whether Parseur runs its own OCR on every document uploaded to this parser."
},
"headers_field": {
"type": "boolean",
"description": "Whether the Headers metadata field is enabled for this parser."
},
"html_document_field": {
"type": "boolean",
"description": "Whether the HTMLDocument metadata field is enabled for this parser."
},
"identification_status": {
"type": [
"string",
"null"
],
"description": "Identification Status",
"enum": [
"REQUESTED",
"PROGRESS",
"COMPLETED",
"MANUAL"
]
},
"input_date_format": {
"type": [
"string",
"null"
],
"description": "Input Date Format",
"enum": [
"MONTH_FIRST",
"DAY_FIRST"
]
},
"is_master": {
"type": "boolean",
"description": "Whether this is a master parser that passes its instructions on to others."
},
"is_transform_enabled": {
"type": "boolean",
"description": "Is Transform Enabled"
},
"json_download": {
"type": "string",
"description": "Json Download"
},
"last_activity": {
"type": "string",
"description": "Last Activity"
},
"last_reply_field": {
"type": "boolean",
"description": "Whether the LastReply metadata field is enabled for this parser."
},
"mailbox_id_field": {
"type": "boolean",
"description": "Whether the MailboxID metadata field is enabled for this parser."
},
"master_parser_name": {
"type": "string",
"description": "The name of this parser's master parser."
},
"master_parser_slug": {
"type": [
"string",
"null"
],
"description": "Master Parser Slug",
"enum": [
"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"
]
},
"name": {
"type": "string",
"description": "The name of the parser."
},
"odd_pages": {
"type": "boolean",
"description": "Whether the parser is configured to process only odd page numbers in a document."
},
"original_document_field": {
"type": "boolean",
"description": "Whether the OriginalDocument metadata field is enabled for this parser."
},
"original_recipient_field": {
"type": "boolean",
"description": "Whether the OriginalRecipient metadata field is enabled for this parser."
},
"page_count_field": {
"type": "boolean",
"description": "Whether the PageCount metadata field is enabled for this parser."
},
"page_range_set": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start_index": {
"type": "integer",
"description": "Start Index"
},
"end_index": {
"type": "integer",
"description": "End Index"
}
},
"required": [
"start_index",
"end_index"
]
},
"description": "The range of pages set to be processed in the parser."
},
"parent_id_field": {
"type": "boolean",
"description": "Whether the ParentID metadata field is enabled for this parser."
},
"parser_object_count": {
"type": "integer",
"description": "The total number of field and metadata outputs currently configured in the parser."
},
"parser_object_set": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"name": {
"type": "string",
"description": "The name value"
},
"format": {
"type": "string",
"enum": [
"TEXT",
"ONELINE",
"DATE",
"TIME",
"DATETIME",
"NUMBER",
"NAME",
"ADDRESS",
"TABLE",
"LINK"
],
"description": "The format value"
},
"choice_set": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of possible choice values. Only used when format is ONELINE."
},
"is_required": {
"type": "boolean",
"description": "Is Required"
},
"query": {
"type": "string",
"description": "Instructions for AI engine"
},
"json_download": {
"type": "string",
"format": "uri",
"description": "Json Download"
},
"csv_download": {
"type": "string",
"format": "uri",
"description": "Csv Download"
},
"xls_download": {
"type": "string",
"format": "uri",
"description": "Xls Download"
},
"type": {
"type": "string",
"description": "The type value"
},
"parser_object_set": {
"type": "array",
"items": {
"type": "object"
},
"description": "Only for TABLE fields"
},
"used_by_ai": {
"type": "boolean",
"description": "If false, that field will not be extracted by AI engines"
}
},
"required": [
"id",
"name",
"format"
]
},
"description": "The list of fields in a parser."
},
"parser_object_set_last_modified": {
"type": "string",
"description": "Parser Object Set Last Modified"
},
"parsing_engine_field": {
"type": "boolean",
"description": "Whether the ParsingEngine metadata field is enabled for this parser."
},
"pdf_conversion_format": {
"type": "string",
"description": "Pdf Conversion Format"
},
"process_attachments": {
"type": "boolean",
"description": "Whether email attachment processing is enabled on this parser."
},
"processed_date_field": {
"type": "boolean",
"description": "Whether the ProcessedDate metadata field is enabled for this parser."
},
"processed_field": {
"type": "boolean",
"description": "Whether the Processed metadata field is enabled for this parser."
},
"processed_time_field": {
"type": "boolean",
"description": "Whether the ProcessedTime metadata field is enabled for this parser."
},
"public_document_url_field": {
"type": "boolean",
"description": "Whether the PublicDocumentURL metadata field is enabled for this parser."
},
"received_date_field": {
"type": "boolean",
"description": "Whether the ReceivedDate metadata field is enabled for this parser."
},
"received_field": {
"type": "boolean",
"description": "Whether the Received metadata field is enabled for this parser."
},
"received_time_field": {
"type": "boolean",
"description": "Whether the ReceivedTime metadata field is enabled for this parser."
},
"recipient_field": {
"type": "boolean",
"description": "Whether the Recipient metadata field is enabled for this parser."
},
"recipient_suffix_field": {
"type": "boolean",
"description": "Whether the RecipientSuffix metadata field is enabled for this parser."
},
"reply_to_field": {
"type": "boolean",
"description": "Whether the ReplyTo metadata field is enabled for this parser."
},
"retention_policy": {
"type": "integer",
"description": "How many days documents and data are stored on our servers before deletion (90 days is the detaulf)."
},
"searchable_pdf_field": {
"type": "boolean",
"description": "Whether the SearchablePDF metadata field is enabled for this parser."
},
"secret": {
"type": "string",
"description": "The secret value"
},
"sender_field": {
"type": "boolean",
"description": "Whether the Sender metadata field is enabled for this parser."
},
"sender_name_field": {
"type": "boolean",
"description": "Whether the SenderName metadata field is enabled for this parser."
},
"split_keywords": {
"type": "object",
"description": "The keyword(s) the parser will look for when splitting documents by page.",
"properties": {
"keyword": {
"type": "string",
"description": "The keyword value"
},
"is_before": {
"type": "boolean",
"description": "Is Before"
}
},
"required": [
"keyword",
"is_before"
]
},
"split_page": {
"type": [
"integer",
"null"
],
"description": "If not 0, this is the number of pages the parser will use to split in a file uploaded to this parser. If set to three, the parser will split a 30 page document 10 times, resulting in 10 files."
},
"split_page_range_field": {
"type": "boolean",
"description": "Whether the SplitPageRange metadata field is enabled for this parser."
},
"split_page_range_set": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start_index": {
"type": "integer",
"description": "Start Index"
},
"end_index": {
"type": "integer",
"description": "End Index"
}
},
"required": [
"start_index",
"end_index"
]
},
"description": "The specific page ranges set to be captured in this parser. Can have multiple values, i.e. 1,3-5,(1)"
},
"subject_field": {
"type": "boolean",
"description": "Whether the Subject metadata field is enabled for this parser."
},
"table_set": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"id",
"name"
]
},
"description": "Table Set"
},
"template_count": {
"type": "integer",
"description": "The number of templates the parser has."
},
"template_field": {
"type": "boolean",
"description": "Whether the Template metadata field is enabled for this parser."
},
"template_set_last_modified": {
"type": [
"string",
"null"
],
"description": "Template Set Last Modified"
},
"text_document_field": {
"type": "boolean",
"description": "Whether the TextDocument metadata field is enabled for this parser."
},
"to_field": {
"type": "boolean",
"description": "Whether the To metadata field is enabled for this parser."
},
"transform": {
"type": [
"string",
"null"
],
"description": "The transform value"
},
"use_whitelist_instead_of_blacklist": {
"type": "boolean",
"description": "Use Whitelist Instead Of Blacklist"
},
"webhook_count": {
"type": "integer",
"description": "The number of webhooks the parser has."
},
"webhook_set": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The id value"
},
"event": {
"type": "string",
"enum": [
"document.processed",
"document.processed.flattened",
"document.template_needed",
"document.export_failed",
"table.processed"
],
"description": "The event value"
},
"target": {
"type": "string",
"format": "uri",
"description": "The target value"
},
"name": {
"type": "string",
"description": "The name value"
},
"headers": {
"type": "object",
"description": "The headers value"
},
"category": {
"type": "string",
"enum": [
"CUSTOM",
"ZAPIER",
"MAKE",
"FLOW",
"N8N"
],
"description": "The category value"
},
"parser_field_set": {
"type": "array",
"items": {
"type": "string"
},
"description": "Only for table.processed events"
}
},
"required": [
"id",
"event",
"target",
"category"
]
},
"description": "Webhook Set"
},
"xls_download": {
"type": "string",
"description": "Xls Download"
}
},
"required": [
"PCID",
"id",
"account_uuid",
"attachments_only",
"is_master"
]
}
```
***
## parseur\_get\_template
Get a template
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------ |
| `id` | integer | Yes | — | The id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## parseur\_list\_parser
List mailboxes
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | --------------------------------------------------- |
| `page` | integer | No | — | Page number for pagination (default is 1) |
| `page_size` | integer | No | — | Number of results per page (default is 25) |
| `search` | string | No | — | Case-insensitive partial match search |
| `ordering` | string | No | — | Field name to order by (use -prefix for descending) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number for pagination (default is 1)"
},
"page_size": {
"type": "integer",
"description": "Number of results per page (default is 25)"
},
"search": {
"type": "string",
"description": "Case-insensitive partial match search"
},
"ordering": {
"type": "string",
"description": "Field name to order by (use -prefix for descending)",
"enum": [
"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"
]
}
},
"required": [
"PCID"
]
}
```
***
## parseur\_process\_document
Reprocess a document
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------ |
| `id` | string | Yes | — | The id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## parseur\_skip\_document
Skip a document
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------ |
| `id` | string | Yes | — | The id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## parseur\_update\_parser
Update a mailbox
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id` | integer | Yes | — | The id value | |
| `account_uuid` | string | Yes | — | The Universally Unique Identifier for your account. | |
| `ai_engine` | string | No | — | Ai Engine | |
| `ai_instructions` | string | null | No | — | General AI instruction for this parser. |
| `allowed_extensions` | string\[] | No | — | List of files extensions to process. If not present, all extensions will be enabled. | |
| `attachments_field` | boolean | No | — | Whether the Attachments metadata field is enabled for this parser. | |
| `attachments_only` | boolean | Yes | — | Whether the parser in question skips email processing or not (read-only). | |
| `attachments_only_override` | boolean | null | No | — | Use this to update attachments\_only. |
| `available_webhook_set` | object\[] | No | — | Available Webhook Set | |
| `bcc_field` | boolean | No | — | Whether the BCC metadata field is enabled for this parser. | |
| `can_transform` | boolean | No | — | Whether Python Post-Processing is enabled for this parser. | |
| `cc_field` | boolean | No | — | Whether the CC metadata field is enabled for this parser. | |
| `content_field` | boolean | No | — | Whether the Content metadata field is enabled for this parser. | |
| `credit_count_field` | boolean | No | — | Whether the CreditCount metadata field is enabled for this parser. | |
| `csv_download` | string | No | — | Csv Download | |
| `decimal_separator` | string | null | No | — | Decimal Separator |
| `default_timezone` | string | null | No | — | Default Timezone |
| `disable_deskew` | boolean | No | — | Whether deskew is disabled for this parser (enabled by default). | |
| `disable_document_links` | boolean | No | — | Disable Document Links | |
| `document_count` | integer | No | — | The number of documents in the parser. | |
| `document_id_field` | boolean | No | — | Whether the DocumentID metadata field is enabled for this parser. | |
| `document_per_status_count` | object | No | — | This is a breakdown of the documents in the parser by status. | |
| `document_url_field` | boolean | No | — | Whether the DocumentURL metadata field is enabled for this parser. | |
| `email_prefix` | string | No | — | The email prefix for the parser. | |
| `emails_or_domains` | any\[] | No | — | Emails Or Domains | |
| `enable_layouted_text` | boolean | No | — | Enable Layouted Text | |
| `even_pages` | boolean | No | — | Whether the parser is configured to process only even page numbers in a document. | |
| `expand_result` | boolean | No | — | Expand Result | |
| `extract_xml_from_comment` | boolean | No | — | Extract Xml From Comment | |
| `force_ocr` | boolean | No | — | Whether Parseur runs its own OCR on every document uploaded to this parser. | |
| `headers_field` | boolean | No | — | Whether the Headers metadata field is enabled for this parser. | |
| `html_document_field` | boolean | No | — | Whether the HTMLDocument metadata field is enabled for this parser. | |
| `identification_status` | string | null | No | — | Identification Status |
| `input_date_format` | string | null | No | — | Input Date Format |
| `is_master` | boolean | Yes | — | Whether this is a master parser that passes its instructions on to others. | |
| `is_transform_enabled` | boolean | No | — | Is Transform Enabled | |
| `json_download` | string | No | — | Json Download | |
| `last_activity` | string | No | — | Last Activity | |
| `last_reply_field` | boolean | No | — | Whether the LastReply metadata field is enabled for this parser. | |
| `mailbox_id_field` | boolean | No | — | Whether the MailboxID metadata field is enabled for this parser. | |
| `master_parser_name` | string | No | — | The name of this parser's master parser. | |
| `master_parser_slug` | string | null | No | — | Master Parser Slug |
| `name` | string | No | — | The name of the parser. | |
| `odd_pages` | boolean | No | — | Whether the parser is configured to process only odd page numbers in a document. | |
| `original_document_field` | boolean | No | — | Whether the OriginalDocument metadata field is enabled for this parser. | |
| `original_recipient_field` | boolean | No | — | Whether the OriginalRecipient metadata field is enabled for this parser. | |
| `page_count_field` | boolean | No | — | Whether the PageCount metadata field is enabled for this parser. | |
| `page_range_set` | object\[] | No | — | The range of pages set to be processed in the parser. | |
| `parent_id_field` | boolean | No | — | Whether the ParentID metadata field is enabled for this parser. | |
| `parser_object_count` | integer | No | — | The total number of field and metadata outputs currently configured in the parser. | |
| `parser_object_set` | object\[] | No | — | The list of fields in a parser. | |
| `parser_object_set_last_modified` | string | No | — | Parser Object Set Last Modified | |
| `parsing_engine_field` | boolean | No | — | Whether the ParsingEngine metadata field is enabled for this parser. | |
| `pdf_conversion_format` | string | No | — | Pdf Conversion Format | |
| `process_attachments` | boolean | No | — | Whether email attachment processing is enabled on this parser. | |
| `processed_date_field` | boolean | No | — | Whether the ProcessedDate metadata field is enabled for this parser. | |
| `processed_field` | boolean | No | — | Whether the Processed metadata field is enabled for this parser. | |
| `processed_time_field` | boolean | No | — | Whether the ProcessedTime metadata field is enabled for this parser. | |
| `public_document_url_field` | boolean | No | — | Whether the PublicDocumentURL metadata field is enabled for this parser. | |
| `received_date_field` | boolean | No | — | Whether the ReceivedDate metadata field is enabled for this parser. | |
| `received_field` | boolean | No | — | Whether the Received metadata field is enabled for this parser. | |
| `received_time_field` | boolean | No | — | Whether the ReceivedTime metadata field is enabled for this parser. | |
| `recipient_field` | boolean | No | — | Whether the Recipient metadata field is enabled for this parser. | |
| `recipient_suffix_field` | boolean | No | — | Whether the RecipientSuffix metadata field is enabled for this parser. | |
| `reply_to_field` | boolean | No | — | Whether the ReplyTo metadata field is enabled for this parser. | |
| `retention_policy` | integer | No | — | How many days documents and data are stored on our servers before deletion (90 days is the detaulf). | |
| `searchable_pdf_field` | boolean | No | — | Whether the SearchablePDF metadata field is enabled for this parser. | |
| `secret` | string | No | — | The secret value | |
| `sender_field` | boolean | No | — | Whether the Sender metadata field is enabled for this parser. | |
| `sender_name_field` | boolean | No | — | Whether the SenderName metadata field is enabled for this parser. | |
| `split_keywords` | object | No | — | The keyword(s) the parser will look for when splitting documents by page. | |
| `split_page` | integer | null | No | — | If not 0, this is the number of pages the parser will use to split in a file uploaded to this parser. If set to three, the parser will split a 30 page document 10 times, resulting in 10 files. |
| `split_page_range_field` | boolean | No | — | Whether the SplitPageRange metadata field is enabled for this parser. | |
| `split_page_range_set` | object\[] | No | — | The specific page ranges set to be captured in this parser. Can have multiple values, i.e. 1,3-5,(1) | |
| `subject_field` | boolean | No | — | Whether the Subject metadata field is enabled for this parser. | |
| `table_set` | object\[] | No | — | Table Set | |
| `template_count` | integer | No | — | The number of templates the parser has. | |
| `template_field` | boolean | No | — | Whether the Template metadata field is enabled for this parser. | |
| `template_set_last_modified` | string | null | No | — | Template Set Last Modified |
| `text_document_field` | boolean | No | — | Whether the TextDocument metadata field is enabled for this parser. | |
| `to_field` | boolean | No | — | Whether the To metadata field is enabled for this parser. | |
| `transform` | string | null | No | — | The transform value |
| `use_whitelist_instead_of_blacklist` | boolean | No | — | Use Whitelist Instead Of Blacklist | |
| `webhook_count` | integer | No | — | The number of webhooks the parser has. | |
| `webhook_set` | object\[] | No | — | Webhook Set | |
| `xls_download` | string | No | — | Xls Download | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
},
"account_uuid": {
"type": "string",
"description": "The Universally Unique Identifier for your account."
},
"ai_engine": {
"type": "string",
"description": "Ai Engine",
"enum": [
"DISABLED",
"GCP_AI_1",
"GCP_AI_2",
"GCP_AI_2_5"
]
},
"ai_instructions": {
"type": [
"string",
"null"
],
"description": "General AI instruction for this parser."
},
"allowed_extensions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"bmp",
"csv",
"doc",
"docx",
"eml",
"gif",
"html",
"ics",
"jpg",
"mbox",
"msg",
"ods",
"odt",
"pdf",
"png",
"rtf",
"tif",
"txt",
"xhtml",
"xls",
"xlsm",
"xlsx",
"xml",
"zip"
]
},
"description": "List of files extensions to process. If not present, all extensions will be enabled."
},
"attachments_field": {
"type": "boolean",
"description": "Whether the Attachments metadata field is enabled for this parser."
},
"attachments_only": {
"type": "boolean",
"description": "Whether the parser in question skips email processing or not (read-only)."
},
"attachments_only_override": {
"type": [
"boolean",
"null"
],
"description": "Use this to update attachments_only."
},
"available_webhook_set": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The id value"
},
"event": {
"type": "string",
"enum": [
"document.processed",
"document.processed.flattened",
"document.template_needed",
"document.export_failed",
"table.processed"
],
"description": "The event value"
},
"target": {
"type": "string",
"format": "uri",
"description": "The target value"
},
"name": {
"type": "string",
"description": "The name value"
},
"headers": {
"type": "object",
"description": "The headers value"
},
"category": {
"type": "string",
"enum": [
"CUSTOM",
"ZAPIER",
"MAKE",
"FLOW",
"N8N"
],
"description": "The category value"
},
"parser_field_set": {
"type": "array",
"items": {
"type": "string"
},
"description": "Only for table.processed events"
}
},
"required": [
"id",
"event",
"target",
"category"
]
},
"description": "Available Webhook Set"
},
"bcc_field": {
"type": "boolean",
"description": "Whether the BCC metadata field is enabled for this parser."
},
"can_transform": {
"type": "boolean",
"description": "Whether Python Post-Processing is enabled for this parser."
},
"cc_field": {
"type": "boolean",
"description": "Whether the CC metadata field is enabled for this parser."
},
"content_field": {
"type": "boolean",
"description": "Whether the Content metadata field is enabled for this parser."
},
"credit_count_field": {
"type": "boolean",
"description": "Whether the CreditCount metadata field is enabled for this parser."
},
"csv_download": {
"type": "string",
"description": "Csv Download"
},
"decimal_separator": {
"type": [
"string",
"null"
],
"description": "Decimal Separator",
"enum": [
".",
","
]
},
"default_timezone": {
"type": [
"string",
"null"
],
"description": "Default Timezone"
},
"disable_deskew": {
"type": "boolean",
"description": "Whether deskew is disabled for this parser (enabled by default)."
},
"disable_document_links": {
"type": "boolean",
"description": "Disable Document Links"
},
"document_count": {
"type": "integer",
"description": "The number of documents in the parser."
},
"document_id_field": {
"type": "boolean",
"description": "Whether the DocumentID metadata field is enabled for this parser."
},
"document_per_status_count": {
"type": "object",
"description": "This is a breakdown of the documents in the parser by status.",
"properties": {
"INCOMING": {
"type": "integer",
"description": "Files that have been received by our system but are awaiting processing."
},
"ANALYZING": {
"type": "integer",
"description": "Files being analyzed against our system's import parameters and the user's mailbox settings."
},
"PROGRESS": {
"type": "integer",
"description": "Files currently being processed by active AI engine for that mailbox."
},
"PARSEDOK": {
"type": "integer",
"description": "Files that have been processed and data is available for export."
},
"PARSEDKO": {
"type": "integer",
"description": "Files where processing failed."
},
"QUOTAEXC": {
"type": "integer",
"description": "Files where processing was stopped because the user does not have enough credits to process them."
},
"SKIPPED": {
"type": "integer",
"description": "Files that were skipped because of a template."
},
"SPLIT": {
"type": "integer",
"description": "Files that were split into multiple documents."
},
"EXPORTKO": {
"type": "integer",
"description": "Files where exporting the parsed data failed."
},
"TRANSKO": {
"type": "integer",
"description": "Files where our Python post-processing failed to process."
},
"INVALID": {
"type": "integer",
"description": "Files that were not processed because they are not supported by our system."
}
},
"required": [
"INCOMING",
"ANALYZING",
"PROGRESS",
"PARSEDOK",
"PARSEDKO",
"QUOTAEXC",
"SKIPPED",
"SPLIT",
"EXPORTKO",
"TRANSKO",
"INVALID"
]
},
"document_url_field": {
"type": "boolean",
"description": "Whether the DocumentURL metadata field is enabled for this parser."
},
"email_prefix": {
"type": "string",
"description": "The email prefix for the parser."
},
"emails_or_domains": {
"type": "array",
"description": "Emails Or Domains"
},
"enable_layouted_text": {
"type": "boolean",
"description": "Enable Layouted Text"
},
"even_pages": {
"type": "boolean",
"description": "Whether the parser is configured to process only even page numbers in a document."
},
"expand_result": {
"type": "boolean",
"description": "Expand Result"
},
"extract_xml_from_comment": {
"type": "boolean",
"description": "Extract Xml From Comment"
},
"force_ocr": {
"type": "boolean",
"description": "Whether Parseur runs its own OCR on every document uploaded to this parser."
},
"headers_field": {
"type": "boolean",
"description": "Whether the Headers metadata field is enabled for this parser."
},
"html_document_field": {
"type": "boolean",
"description": "Whether the HTMLDocument metadata field is enabled for this parser."
},
"identification_status": {
"type": [
"string",
"null"
],
"description": "Identification Status",
"enum": [
"REQUESTED",
"PROGRESS",
"COMPLETED",
"MANUAL"
]
},
"input_date_format": {
"type": [
"string",
"null"
],
"description": "Input Date Format",
"enum": [
"MONTH_FIRST",
"DAY_FIRST"
]
},
"is_master": {
"type": "boolean",
"description": "Whether this is a master parser that passes its instructions on to others."
},
"is_transform_enabled": {
"type": "boolean",
"description": "Is Transform Enabled"
},
"json_download": {
"type": "string",
"description": "Json Download"
},
"last_activity": {
"type": "string",
"description": "Last Activity"
},
"last_reply_field": {
"type": "boolean",
"description": "Whether the LastReply metadata field is enabled for this parser."
},
"mailbox_id_field": {
"type": "boolean",
"description": "Whether the MailboxID metadata field is enabled for this parser."
},
"master_parser_name": {
"type": "string",
"description": "The name of this parser's master parser."
},
"master_parser_slug": {
"type": [
"string",
"null"
],
"description": "Master Parser Slug",
"enum": [
"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"
]
},
"name": {
"type": "string",
"description": "The name of the parser."
},
"odd_pages": {
"type": "boolean",
"description": "Whether the parser is configured to process only odd page numbers in a document."
},
"original_document_field": {
"type": "boolean",
"description": "Whether the OriginalDocument metadata field is enabled for this parser."
},
"original_recipient_field": {
"type": "boolean",
"description": "Whether the OriginalRecipient metadata field is enabled for this parser."
},
"page_count_field": {
"type": "boolean",
"description": "Whether the PageCount metadata field is enabled for this parser."
},
"page_range_set": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start_index": {
"type": "integer",
"description": "Start Index"
},
"end_index": {
"type": "integer",
"description": "End Index"
}
},
"required": [
"start_index",
"end_index"
]
},
"description": "The range of pages set to be processed in the parser."
},
"parent_id_field": {
"type": "boolean",
"description": "Whether the ParentID metadata field is enabled for this parser."
},
"parser_object_count": {
"type": "integer",
"description": "The total number of field and metadata outputs currently configured in the parser."
},
"parser_object_set": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"name": {
"type": "string",
"description": "The name value"
},
"format": {
"type": "string",
"enum": [
"TEXT",
"ONELINE",
"DATE",
"TIME",
"DATETIME",
"NUMBER",
"NAME",
"ADDRESS",
"TABLE",
"LINK"
],
"description": "The format value"
},
"choice_set": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of possible choice values. Only used when format is ONELINE."
},
"is_required": {
"type": "boolean",
"description": "Is Required"
},
"query": {
"type": "string",
"description": "Instructions for AI engine"
},
"json_download": {
"type": "string",
"format": "uri",
"description": "Json Download"
},
"csv_download": {
"type": "string",
"format": "uri",
"description": "Csv Download"
},
"xls_download": {
"type": "string",
"format": "uri",
"description": "Xls Download"
},
"type": {
"type": "string",
"description": "The type value"
},
"parser_object_set": {
"type": "array",
"items": {
"type": "object"
},
"description": "Only for TABLE fields"
},
"used_by_ai": {
"type": "boolean",
"description": "If false, that field will not be extracted by AI engines"
}
},
"required": [
"id",
"name",
"format"
]
},
"description": "The list of fields in a parser."
},
"parser_object_set_last_modified": {
"type": "string",
"description": "Parser Object Set Last Modified"
},
"parsing_engine_field": {
"type": "boolean",
"description": "Whether the ParsingEngine metadata field is enabled for this parser."
},
"pdf_conversion_format": {
"type": "string",
"description": "Pdf Conversion Format"
},
"process_attachments": {
"type": "boolean",
"description": "Whether email attachment processing is enabled on this parser."
},
"processed_date_field": {
"type": "boolean",
"description": "Whether the ProcessedDate metadata field is enabled for this parser."
},
"processed_field": {
"type": "boolean",
"description": "Whether the Processed metadata field is enabled for this parser."
},
"processed_time_field": {
"type": "boolean",
"description": "Whether the ProcessedTime metadata field is enabled for this parser."
},
"public_document_url_field": {
"type": "boolean",
"description": "Whether the PublicDocumentURL metadata field is enabled for this parser."
},
"received_date_field": {
"type": "boolean",
"description": "Whether the ReceivedDate metadata field is enabled for this parser."
},
"received_field": {
"type": "boolean",
"description": "Whether the Received metadata field is enabled for this parser."
},
"received_time_field": {
"type": "boolean",
"description": "Whether the ReceivedTime metadata field is enabled for this parser."
},
"recipient_field": {
"type": "boolean",
"description": "Whether the Recipient metadata field is enabled for this parser."
},
"recipient_suffix_field": {
"type": "boolean",
"description": "Whether the RecipientSuffix metadata field is enabled for this parser."
},
"reply_to_field": {
"type": "boolean",
"description": "Whether the ReplyTo metadata field is enabled for this parser."
},
"retention_policy": {
"type": "integer",
"description": "How many days documents and data are stored on our servers before deletion (90 days is the detaulf)."
},
"searchable_pdf_field": {
"type": "boolean",
"description": "Whether the SearchablePDF metadata field is enabled for this parser."
},
"secret": {
"type": "string",
"description": "The secret value"
},
"sender_field": {
"type": "boolean",
"description": "Whether the Sender metadata field is enabled for this parser."
},
"sender_name_field": {
"type": "boolean",
"description": "Whether the SenderName metadata field is enabled for this parser."
},
"split_keywords": {
"type": "object",
"description": "The keyword(s) the parser will look for when splitting documents by page.",
"properties": {
"keyword": {
"type": "string",
"description": "The keyword value"
},
"is_before": {
"type": "boolean",
"description": "Is Before"
}
},
"required": [
"keyword",
"is_before"
]
},
"split_page": {
"type": [
"integer",
"null"
],
"description": "If not 0, this is the number of pages the parser will use to split in a file uploaded to this parser. If set to three, the parser will split a 30 page document 10 times, resulting in 10 files."
},
"split_page_range_field": {
"type": "boolean",
"description": "Whether the SplitPageRange metadata field is enabled for this parser."
},
"split_page_range_set": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start_index": {
"type": "integer",
"description": "Start Index"
},
"end_index": {
"type": "integer",
"description": "End Index"
}
},
"required": [
"start_index",
"end_index"
]
},
"description": "The specific page ranges set to be captured in this parser. Can have multiple values, i.e. 1,3-5,(1)"
},
"subject_field": {
"type": "boolean",
"description": "Whether the Subject metadata field is enabled for this parser."
},
"table_set": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"id",
"name"
]
},
"description": "Table Set"
},
"template_count": {
"type": "integer",
"description": "The number of templates the parser has."
},
"template_field": {
"type": "boolean",
"description": "Whether the Template metadata field is enabled for this parser."
},
"template_set_last_modified": {
"type": [
"string",
"null"
],
"description": "Template Set Last Modified"
},
"text_document_field": {
"type": "boolean",
"description": "Whether the TextDocument metadata field is enabled for this parser."
},
"to_field": {
"type": "boolean",
"description": "Whether the To metadata field is enabled for this parser."
},
"transform": {
"type": [
"string",
"null"
],
"description": "The transform value"
},
"use_whitelist_instead_of_blacklist": {
"type": "boolean",
"description": "Use Whitelist Instead Of Blacklist"
},
"webhook_count": {
"type": "integer",
"description": "The number of webhooks the parser has."
},
"webhook_set": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The id value"
},
"event": {
"type": "string",
"enum": [
"document.processed",
"document.processed.flattened",
"document.template_needed",
"document.export_failed",
"table.processed"
],
"description": "The event value"
},
"target": {
"type": "string",
"format": "uri",
"description": "The target value"
},
"name": {
"type": "string",
"description": "The name value"
},
"headers": {
"type": "object",
"description": "The headers value"
},
"category": {
"type": "string",
"enum": [
"CUSTOM",
"ZAPIER",
"MAKE",
"FLOW",
"N8N"
],
"description": "The category value"
},
"parser_field_set": {
"type": "array",
"items": {
"type": "string"
},
"description": "Only for table.processed events"
}
},
"required": [
"id",
"event",
"target",
"category"
]
},
"description": "Webhook Set"
},
"xls_download": {
"type": "string",
"description": "Xls Download"
}
},
"required": [
"PCID",
"id",
"account_uuid",
"attachments_only",
"is_master"
]
}
```
***
## parseur\_update\_parser\_export\_config
Update a custom download
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------- | --------- | -------- | ------- | --------------- | -------------------------------- |
| `mailbox_id` | string | Yes | — | Mailbox Id | |
| `id` | string | Yes | — | The id value | |
| `csv_download` | string | Yes | — | Csv Download | |
| `items` | string\[] | Yes | — | The items value | |
| `name` | string | null | Yes | — | Download name |
| `parser_field_id` | string | null | No | — | Parser field ID starting with PF |
| `parser_field_name` | string | null | No | — | Parser Field Name |
| `type` | string | Yes | — | The type value | |
| `xls_download` | string | Yes | — | Xls Download | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"mailbox_id": {
"type": "string",
"description": "Mailbox Id"
},
"id": {
"type": "string",
"description": "The id value"
},
"csv_download": {
"type": "string",
"description": "Csv Download"
},
"items": {
"type": "array",
"items": {
"type": "string"
},
"description": "The items value"
},
"name": {
"type": [
"string",
"null"
],
"description": "Download name"
},
"parser_field_id": {
"type": [
"string",
"null"
],
"description": "Parser field ID starting with PF"
},
"parser_field_name": {
"type": [
"string",
"null"
],
"description": "Parser Field Name"
},
"type": {
"type": "string",
"description": "The type value",
"enum": [
"PARSER",
"PARSER_FIELD"
]
},
"xls_download": {
"type": "string",
"description": "Xls Download"
}
},
"required": [
"PCID",
"mailbox_id",
"id",
"csv_download",
"items",
"name",
"type",
"xls_download"
]
}
```
***
## parseur\_upload\_parser
Upload a binary document
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------- |
| `id` | string | Yes | — | The id value |
| `file` | string | Yes | — | The file value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"file": {
"type": "string",
"description": "The file value"
}
},
"required": [
"PCID",
"id",
"file"
]
}
```