### GET /bootstrap

Source: https://api.parseur.com/openapi.json

API endpoint for GET /bootstrap

```markdown
### Responses

#### 200 - response

- **choices** (object) (required)
  - **document.status** (array (array (string))) (required)
  - **document.status_source** (array (array (string))) (required)
  - **parser.ai_engine** (array (array (string))) (required)
  - **parser.ordering** (array (array (string))) (required)
  - **parser.pdf_conversion_format** (array (array (string))) (required)
  - **parser.identification_status** (array (array (string))) (required)
  - **parser_field.format** (array (array (string))) (required)
  - **template.action** (array (array (string))) (required)
  - **template.status** (array (array (string))) (required)
  - **template.merge_row_behavior** (array (array (string))) (required)
  - **template_field.format** (array (array (string))) (required)
  - **template_object.errors.code** (array (array (string))) (required)
  - **account.auto_subscription_feature** (array (array (string))) (required)
  - **account.decimal_separator** (array (array (string))) (required)
  - **account.default_timezone** (array (array (string))) (required)
  - **account.input_date_format** (array (array (string))) (required)
  - **user.roles** (array (array (string))) (required)
  - **user.permissions** (array (array (string))) (required)
  - **webhook.status** (array (array (string))) (required)
  - **webhook.event** (array (array (string))) (required)
  - **log.status** (array (array (string))) (required)
  - **log.source** (array (array (string))) (required)
  - **parser.master** (array (array (string))) (required)
- **mappings** (object) (required)
  - **field.format** (object) (required)
    - **TEXT** (array (string)) (required)
    - **ONELINE** (array (string)) (required)
    - **TABLE** (array (string)) (required)
    - **LIST** (array (string)) (required)
    - **TXT** (object) (required)
      - **TEXT** (array (string)) (required)
      - **ONELINE** (array (string)) (required)
      - **TABLE** (array (string)) (required)
      - **LIST** (array (string)) (required)
    - **OCR** (object) (required)
      - **TABLE** (array (string)) (required)
- **max_field_lengths** (object) (required)
  - **email** (integer) (required)
  - **name** (integer) (required)
- **email_domain** (string) (required)
- **extra_fields** (array (object)) (required)
  Array items:
    - **name** (string) (required)
    - **label** (string) (required)
    - **info** (string) (required)
- **master_parser_set** (array (object)) (required)
  Array items:
    - **slug** (string) (required)
    - **name** (string) (required)
    - **description** (string) (required)

#### 403 - response

- **non_field_errors** (string) (required)

#### 404 - response

- **non_field_errors** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/bootstrap"
```

```

--------------------------------

### GET /parser

Source: https://api.parseur.com/openapi.json

Optional query parameters for pagination and filtering

```markdown
### Parameters

- **page** (integer, query, optional): Page number for pagination (default is 1)
- **page_size** (integer, query, optional): Number of results per page (default is 25)
- **search** (string, query, optional): Case-insensitive partial match search
- **ordering** (string,null, query, optional): Field name to order by (use -prefix for descending)

### Responses

#### 200 - response

- **count** (integer) (required)
- **current** (integer) (required)
- **total** (integer) (required)
- **results** (array (ParserDiet)) (required)
  Array items:
    - **account_uuid** (string (uuid)): The Universally Unique Identifier for your account.
    - **ai_engine** (string (DISABLED|GCP_AI_1|GCP_AI_2|GCP_AI_2_5)) ("DISABLED"|"GCP_AI_1"|"GCP_AI_2"|"GCP_AI_2_5")
    - **attachments_only** (boolean): Whether the parser in question skips email processing or not (read-only).
    - **attachments_only_override** (boolean,null): Use this to update attachments_only.
    - **can_transform** (boolean): Whether Python Post-Processing is enabled for this parser.
    - **disable_deskew** (boolean): Whether deskew is disabled for this parser (enabled by default).
    - **enable_layouted_text** (boolean)
    - **enable_image_ocr** (boolean): Whether this parser supports image processing (enabled by default).
    - **document_count** (integer): The number of documents in the parser.
    - **document_per_status_count** (object): This is a breakdown of the documents in the parser by status.
      - **INCOMING** (integer) (required)
      - **ANALYZING** (integer) (required)
      - **PROGRESS** (integer) (required)
      - **PARSEDOK** (integer) (required)
      - **PARSEDKO** (integer) (required)
      - **QUOTAEXC** (integer) (required)
      - **SKIPPED** (integer) (required)
      - **SPLIT** (integer) (required)
      - **DELETED** (integer) (required)
      - **EXPORTKO** (integer) (required)
      - **TRANSKO** (integer) (required)
      - **INVALID** (integer) (required)
    - **email_prefix** (string): The email prefix for the parser.
    - **even_pages** (boolean): Whether the parser is configured to process only even page numbers in a document.
    - **force_ocr** (boolean): Whether Parseur runs its own OCR on every document uploaded to this parser.
    - **id** (integer): The internal ID number for the parser.
    - **is_master** (boolean): Whether this is a master parser that passes its instructions on to others.
    - **last_activity** (string (date-time))
    - **name** (string): The name of the parser.
    - **odd_pages** (boolean): Whether the parser is configured to process only odd page numbers in a document.
    - **page_range_set** (array (PageRange)): The range of pages set to be processed in the parser.
      Array items:
        - **start_index** (integer) (required)
        - **end_index** (integer,null) (required)
    - **parser_object_count** (integer): The total number of field and metadata outputs currently configured in the parser.
    - **parser_object_set_last_modified** (string,null): The last time the fields of the parser were modified.
    - **process_attachments** (boolean): Whether email attachment processing is enabled on this parser.
    - **retention_policy** (integer): How many days documents and data are stored on our servers before deletion (90 days is the detaulf).
    - **split_keywords** (array,null): The keyword(s) the parser will look for when splitting documents by page.
    - **split_page** (integer,null): 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_set** (array (PageRange)): The specific page ranges set to be captured in this parser. Can have multiple values, i.e. 1,3-5,(1)
      Array items:
    - **template_count** (integer): The number of templates the parser has.
    - **webhook_count** (integer): The number of webhooks the parser has.
    - **attachments_field** (boolean): Whether the Attachments metadata field is enabled for this parser.
    - **original_document_field** (boolean): Whether the OriginalDocument metadata fields are enabled for this parser.
    - **searchable_pdf_field** (boolean): Whether the SearchablePDF metadata field is enabled for this parser.
    - **headers_field** (boolean): Whether the Headers metadata field is enabled for this parser.
    - **received_field** (boolean): Whether the Received metadata field is enabled for this parser.
    - **received_date_field** (boolean): Whether the ReceivedDate metadata field is enabled for this parser.
    - **received_time_field** (boolean): Whether the ReceivedTime metadata field is enabled for this parser.
    - **processed_field** (boolean): Whether the Processed metadata field is enabled for this parser.
    - **processed_date_field** (boolean): Whether the ProcessedDate metadata field is enabled for this parser.
    - **processed_time_field** (boolean): Whether the ProcessedTime metadata field is enabled for this parser.
    - **sender_field** (boolean): Whether the Sender metadata field is enabled for this parser.
    - **sender_name_field** (boolean): Whether the SenderName metadata field is enabled for this parser.
    - **split_page_range_field** (boolean): Whether the SplitPageRange metadata field is enabled for this parser.
    - **recipient_field** (boolean): Whether the Recipient metadata field is enabled for this parser.
    - **to_field** (boolean): Whether the To metadata field is enabled for this parser.
    - **cc_field** (boolean): Whether the CC metadata field is enabled for this parser.
    - **bcc_field** (boolean): Whether the BCC metadata field is enabled for this parser.
    - **reply_to_field** (boolean): Whether the ReplyTo metadata field is enabled for this parser.
    - **recipient_suffix_field** (boolean): Whether the RecipientSuffix metadata field is enabled for this parser.
    - **original_recipient_field** (boolean): Whether the OriginalRecipient metadata field is enabled for this parser.
    - **subject_field** (boolean): Whether the Subject metadata field is enabled for this parser.
    - **template_field** (boolean): Whether the Template metadata field is enabled for this parser.
    - **html_document_field** (boolean): Whether the HTMLDocument metadata field is enabled for this parser.
    - **text_document_field** (boolean): Whether the TextDocument metadata field is enabled for this parser.
    - **content_field** (boolean): Whether the Content metadata field is enabled for this parser.
    - **last_reply_field** (boolean): Whether the LastReply metadata field is enabled for this parser.
    - **document_id_field** (boolean): Whether the DocumentID metadata field is enabled for this parser.
    - **parent_id_field** (boolean): Whether the ParentID metadata field is enabled for this parser.
    - **document_url_field** (boolean): Whether the DocumentURL metadata field is enabled for this parser.
    - **public_document_url_field** (boolean): Whether the PublicDocumentURL metadata field is enabled for this parser.
    - **page_count_field** (boolean): Whether the PageCount metadata field is enabled for this parser.
    - **credit_count_field** (boolean): Whether the CreditCount metadata field is enabled for this parser.
    - **mailbox_id_field** (boolean): Whether the MailboxID metadata field is enabled for this parser.
    - **parsing_engine_field** (boolean): Whether the ParsingEngine metadata field is enabled for this parser.
    - **available_webhook_set** (array (Webhook))
      Array items:
        - **id** (integer) (required)
        - **event** (string (document.processed|document.processed.flattened|document.template_needed|document.export_failed|table.processed)) (required) ("document.processed"|"document.processed.flattened"|"document.template_needed"|"document.export_failed"|"table.processed")
        - **target** (string (uri)) (required)
        - **name** (string)
        - **headers** (object,null)
        - **category** (string (CUSTOM|ZAPIER|MAKE|FLOW|N8N)) (required) ("CUSTOM"|"ZAPIER"|"MAKE"|"FLOW"|"N8N")
        - **parser_field_set** (array (string)): Only for table.processed events
    - **webhook_set** (array (Webhook))
      Array items:
    - **table_set** (array (ParserFieldDiet))
      Array items:
        - **id** (string) (required): ID
        - **name** (string) (required): name

#### 403 - response

- **non_field_errors** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/parser?page=0&page_size=0&search=string&ordering=value"
```

```

--------------------------------

### GET /template/{id}

Source: https://api.parseur.com/openapi.json

API endpoint for GET /template/{id}

```markdown
### Parameters

- **id** (integer, path, required)

### Responses

#### 200 - OK

**Template**
- **id** (integer) (required)
- **name** (string)
- **parser** (integer) (required)
- **engine** (string (TXT|OCR)) (required) ("TXT"|"OCR")
- **action** (string (PROCESS|SKIP|DELETE|PROCESS_THEN_DELETE)) (required) ("PROCESS"|"SKIP"|"DELETE"|"PROCESS_THEN_DELETE")
- **status** (string (DRAFT|PROD)) (required) ("DRAFT"|"PROD")
- **margin** (object)
  - **default** (object) (required)
    - **lower** (integer) (required)
    - **upper** (integer) (required)
- **document_count** (integer) (required)
- **last_activity** (string (date-time)) (required)
- **decimal_separator** (string (.|,)) ("."|",")
- **input_date_format** (string,null) ("MONTH_FIRST"|"DAY_FIRST")
- **template_object_set** (array (TemplateField)) (required)
  Array items:
    - **parser_field** (object)
      - **id** (string) (required)
      - **name** (string) (required)
      - **format** (string (TEXT|ONELINE|DATE|TIME|DATETIME|NUMBER|NAME|ADDRESS|TABLE|LINK)) (required) ("TEXT"|"ONELINE"|"DATE"|"TIME"|"DATETIME"|"NUMBER"|"NAME"|"ADDRESS"|"TABLE"|"LINK")
      - **choice_set** (array,null): List of possible choice values. Only used when format is ONELINE.
      - **is_required** (boolean,null)
      - **query** (string,null): Instructions for AI engine
      - **json_download** (string (uri))
      - **csv_download** (string (uri))
      - **xls_download** (string (uri))
      - **type** (string)
      - **parser_object_set** (array (ParserField)): Only for TABLE fields
        Array items:
      - **used_by_ai** (boolean,null): If false, that field will not be extracted by AI engines
    - **upper_left_relative_field** (string,null): Only for OCR templates
    - **lower_right_relative_field** (string,null): Only for OCR templates
    - **format** (string (HTML|TEXT|RAW|HTML_LIST|TEXT_LIST|HTML_VTABLE|TEXT_VTABLE|HTML_HTABLE|TEXT_HTABLE|OCR_TEXT|OCR_VTABLE|OCR_HTABLE)) ("HTML"|"TEXT"|"RAW"|"HTML_LIST"|"TEXT_LIST"|"HTML_VTABLE"|"TEXT_VTABLE"|"HTML_HTABLE"|"TEXT_HTABLE"|"OCR_TEXT"|"OCR_VTABLE"|"OCR_HTABLE")
    - **id** (string) (required)
    - **is_required** (boolean): Only for OCR templates
    - **name** (string)
    - **relative_box** (object): Only for OCR templates
      - **left_x** (number) (required)
      - **upper_y** (number) (required)
      - **right_x** (number) (required)
      - **lower_y** (number) (required)
      - **start_page_index** (integer) (required)
      - **end_page_index** (integer) (required)
    - **type** (string (FIELD|LABEL|DELIMITER|IGNORED)) ("FIELD"|"LABEL"|"DELIMITER"|"IGNORED")
    - **template_object_set** (array (TemplateField)): Only for TABLE fields
      Array items:
- **template_static_object_set** (array (string)) (required)
- **unused_parser_object_set** (array (ParserField)) (required)
  Array items:
- **sample_set** (array (DocumentSample)): Only for OCR templates
  Array items:
    - **id** (integer)
    - **name** (string)
    - **comment** (string,null)
    - **is_ocr_ready** (boolean)
    - **ocr_ready_url** (string (uri))
    - **ocr_page_set** (array (OcrPage))
      Array items:
        - **image** (object)
          - **url** (string (uri)) (required)
          - **width** (integer) (required)
          - **height** (integer) (required)
          - **content_type** (string) (required)
        - **position** (integer)
        - **included_in_range** (boolean)

#### 403 - response

- **non_field_errors** (string) (required)

#### 404 - Not found

- **non_field_errors** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/template/{id}"
```

```

--------------------------------

### GET /document/{id}

Source: https://api.parseur.com/openapi.json

API endpoint for GET /document/{id}

```markdown
### Parameters

- **id** (string, path, required)

### Responses

#### 200 - OK

**Document**
- **attached_to** (integer,null) (required)
- **id** (integer) (required)
- **match_master_template** (boolean) (required)
- **name** (string) (required)
- **ocr_ready_url** (string,null) (required)
- **original_document_url** (string (uri)) (required)
- **parser** (integer) (required)
- **processed** (string (date-time)) (required)
- **received** (string (date-time)) (required)
- **sample_set** (array (TemplateSample)) (required)
- **status_source** (string,null) (required) ("AI"|"AUTO"|"CSV"|"METADATA"|"MANUAL"|"TEMPLATE"|"TRANSFORM")
- **status** (string (INCOMING|ANALYZING|PROGRESS|PARSEDOK|PARSEDKO|QUOTAEXC|SKIPPED|SPLIT|EXPORTKO|TRANSKO|INVALID)) (required) ("INCOMING"|"ANALYZING"|"PROGRESS"|"PARSEDOK"|"PARSEDKO"|"QUOTAEXC"|"SKIPPED"|"SPLIT"|"EXPORTKO"|"TRANSKO"|"INVALID")
- **template** (integer,null) (required)
- **credits_used** (integer) (required)
- **conventional_credits_used** (integer) (required)
- **ai_credits_used** (integer) (required)
- **is_ai_ready** (boolean) (required)
- **is_ocr_ready** (boolean) (required)
- **is_processable** (boolean) (required)
- **is_splittable** (boolean) (required)
- **is_split** (boolean) (required)
- **json_download_url** (string (uri)) (required)
- **csv_download_url** (string (uri)) (required)
- **xls_download_url** (string (uri)) (required)
- **result** (string,null) (required)
- **content** (string) (required)
- **next_id** (integer,null) (required)
- **prev_id** (integer,null) (required)
- **ocr_page_set** (array (OcrPage)) (required)
  Array items:
    - **image** (object)
      - **url** (string (uri)) (required)
      - **width** (integer) (required)
      - **height** (integer) (required)
      - **content_type** (string) (required)
    - **position** (integer)
    - **included_in_range** (boolean)

#### 403 - response

- **non_field_errors** (string) (required)

#### 404 - response

- **non_field_errors** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/document/{id}"
```

```

--------------------------------

### GET /parser/{id}

Source: https://api.parseur.com/openapi.json

API endpoint for GET /parser/{id}

```markdown
### Parameters

- **id** (integer, path, required)

### Responses

#### 200 - Mailbox retrieved

**Parser**
- **account_uuid** (string (uuid)) (required): The Universally Unique Identifier for your account.
- **ai_engine** (string (DISABLED|GCP_AI_1|GCP_AI_2|GCP_AI_2_5)) ("DISABLED"|"GCP_AI_1"|"GCP_AI_2"|"GCP_AI_2_5")
- **ai_instructions** (string,null): General AI instruction for this parser.
- **allowed_extensions** (array (string (bmp|csv|doc|docx|eml|gif|html|ics|jpg|mbox|msg|ods|odt|pdf|png|rtf|tif|txt|xhtml|xls|xlsm|xlsx|xml|zip))): List of files extensions to process. If not present, all extensions will be enabled.
- **attachments_only** (boolean) (required): Whether the parser in question skips email processing or not (read-only).
- **attachments_only_override** (boolean,null): Use this to update attachments_only.
- **can_transform** (boolean) (required): Whether Python Post-Processing is enabled for this parser.
- **disable_deskew** (boolean): Whether deskew is disabled for this parser (enabled by default).
- **enable_layouted_text** (boolean)
- **document_count** (integer) (required): The number of documents in the parser.
- **document_per_status_count** (object) (required): This is a breakdown of the documents in the parser by status.
  - **INCOMING** (integer) (required): Files that have been received by our system but are awaiting processing.
  - **ANALYZING** (integer) (required): Files being analyzed against our system's import parameters and the user's mailbox settings.
  - **PROGRESS** (integer) (required): Files currently being processed by active AI engine for that mailbox.
  - **PARSEDOK** (integer) (required): Files that have been processed and data is available for export.
  - **PARSEDKO** (integer) (required): Files where processing failed.
  - **QUOTAEXC** (integer) (required): Files where processing was stopped because the user does not have enough credits to process them.
  - **SKIPPED** (integer) (required): Files that were skipped because of a template.
  - **SPLIT** (integer) (required): Files that were split into multiple documents.
  - **EXPORTKO** (integer) (required): Files where exporting the parsed data failed.
  - **TRANSKO** (integer) (required): Files where our Python post-processing failed to process.
  - **INVALID** (integer) (required): Files that were not processed because they are not supported by our system.
- **email_prefix** (string): The email prefix for the parser.
- **even_pages** (boolean): Whether the parser is configured to process only even page numbers in a document.
- **force_ocr** (boolean): Whether Parseur runs its own OCR on every document uploaded to this parser.
- **id** (integer) (required): The internal ID number for the parser.
- **is_master** (boolean) (required): Whether this is a master parser that passes its instructions on to others.
- **last_activity** (string (date-time)) (required)
- **master_parser_name** (string): The name of this parser's master parser.
- **master_parser_slug** (string,null) ("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** (string): The name of the parser.
- **odd_pages** (boolean): Whether the parser is configured to process only odd page numbers in a document.
- **page_range_set** (array (PageRange)): The range of pages set to be processed in the parser.
  Array items:
    - **start_index** (integer) (required)
    - **end_index** (integer,null) (required)
- **parser_object_count** (integer) (required): The total number of field and metadata outputs currently configured in the parser.
- **parser_object_set_last_modified** (string (date-time)) (required)
- **process_attachments** (boolean): Whether email attachment processing is enabled on this parser.
- **retention_policy** (integer): How many days documents and data are stored on our servers before deletion (90 days is the detaulf).
- **split_keywords** (object)
  - **keyword** (string) (required)
  - **is_before** (boolean) (required)
- **split_page** (integer,null): 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_set** (array (PageRange)): The specific page ranges set to be captured in this parser. Can have multiple values, i.e. 1,3-5,(1)
  Array items:
- **template_count** (integer): The number of templates the parser has.
- **webhook_count** (integer): The number of webhooks the parser has.
- **attachments_field** (boolean): Whether the Attachments metadata field is enabled for this parser.
- **original_document_field** (boolean): Whether the OriginalDocument metadata field is enabled for this parser.
- **searchable_pdf_field** (boolean): Whether the SearchablePDF metadata field is enabled for this parser.
- **headers_field** (boolean): Whether the Headers metadata field is enabled for this parser.
- **received_field** (boolean): Whether the Received metadata field is enabled for this parser.
- **received_date_field** (boolean): Whether the ReceivedDate metadata field is enabled for this parser.
- **received_time_field** (boolean): Whether the ReceivedTime metadata field is enabled for this parser.
- **processed_field** (boolean): Whether the Processed metadata field is enabled for this parser.
- **processed_date_field** (boolean): Whether the ProcessedDate metadata field is enabled for this parser.
- **processed_time_field** (boolean): Whether the ProcessedTime metadata field is enabled for this parser.
- **sender_field** (boolean): Whether the Sender metadata field is enabled for this parser.
- **sender_name_field** (boolean): Whether the SenderName metadata field is enabled for this parser.
- **split_page_range_field** (boolean): Whether the SplitPageRange metadata field is enabled for this parser.
- **recipient_field** (boolean): Whether the Recipient metadata field is enabled for this parser.
- **to_field** (boolean): Whether the To metadata field is enabled for this parser.
- **cc_field** (boolean): Whether the CC metadata field is enabled for this parser.
- **bcc_field** (boolean): Whether the BCC metadata field is enabled for this parser.
- **reply_to_field** (boolean): Whether the ReplyTo metadata field is enabled for this parser.
- **recipient_suffix_field** (boolean): Whether the RecipientSuffix metadata field is enabled for this parser.
- **original_recipient_field** (boolean): Whether the OriginalRecipient metadata field is enabled for this parser.
- **subject_field** (boolean): Whether the Subject metadata field is enabled for this parser.
- **template_field** (boolean): Whether the Template metadata field is enabled for this parser.
- **html_document_field** (boolean): Whether the HTMLDocument metadata field is enabled for this parser.
- **text_document_field** (boolean): Whether the TextDocument metadata field is enabled for this parser.
- **content_field** (boolean): Whether the Content metadata field is enabled for this parser.
- **last_reply_field** (boolean): Whether the LastReply metadata field is enabled for this parser.
- **document_id_field** (boolean): Whether the DocumentID metadata field is enabled for this parser.
- **parent_id_field** (boolean): Whether the ParentID metadata field is enabled for this parser.
- **document_url_field** (boolean): Whether the DocumentURL metadata field is enabled for this parser.
- **public_document_url_field** (boolean): Whether the PublicDocumentURL metadata field is enabled for this parser.
- **page_count_field** (boolean): Whether the PageCount metadata field is enabled for this parser.
- **credit_count_field** (boolean): Whether the CreditCount metadata field is enabled for this parser.
- **mailbox_id_field** (boolean): Whether the MailboxID metadata field is enabled for this parser.
- **parsing_engine_field** (boolean): Whether the ParsingEngine metadata field is enabled for this parser.
- **csv_download** (string (uri)) (required)
- **decimal_separator** (string (.|,)) ("."|",")
- **default_timezone** (string,null)
- **disable_document_links** (boolean)
- **expand_result** (boolean)
- **extract_xml_from_comment** (boolean)
- **input_date_format** (string,null) ("MONTH_FIRST"|"DAY_FIRST")
- **identification_status** (string,null) ("REQUESTED"|"PROGRESS"|"COMPLETED"|"MANUAL")
- **is_transform_enabled** (boolean)
- **json_download** (string (uri)) (required)
- **parser_object_set** (array (ParserField)): The list of fields in a parser.
  Array items:
    - **id** (string) (required)
    - **name** (string) (required)
    - **format** (string (TEXT|ONELINE|DATE|TIME|DATETIME|NUMBER|NAME|ADDRESS|TABLE|LINK)) (required) ("TEXT"|"ONELINE"|"DATE"|"TIME"|"DATETIME"|"NUMBER"|"NAME"|"ADDRESS"|"TABLE"|"LINK")
    - **choice_set** (array,null): List of possible choice values. Only used when format is ONELINE.
    - **is_required** (boolean,null)
    - **query** (string,null): Instructions for AI engine
    - **json_download** (string (uri))
    - **csv_download** (string (uri))
    - **xls_download** (string (uri))
    - **type** (string)
    - **parser_object_set** (array (ParserField)): Only for TABLE fields
      Array items:
    - **used_by_ai** (boolean,null): If false, that field will not be extracted by AI engines
- **pdf_conversion_format** (string)
- **secret** (string) (required)
- **transform** (string,null)
- **use_whitelist_instead_of_blacklist** (boolean)
- **template_set_last_modified** (string,null) (required)
- **webhook_set** (array (Webhook))
  Array items:
    - **id** (integer) (required)
    - **event** (string (document.processed|document.processed.flattened|document.template_needed|document.export_failed|table.processed)) (required) ("document.processed"|"document.processed.flattened"|"document.template_needed"|"document.export_failed"|"table.processed")
    - **target** (string (uri)) (required)
    - **name** (string)
    - **headers** (object,null)
    - **category** (string (CUSTOM|ZAPIER|MAKE|FLOW|N8N)) (required) ("CUSTOM"|"ZAPIER"|"MAKE"|"FLOW"|"N8N")
    - **parser_field_set** (array (string)): Only for table.processed events
- **xls_download** (string (uri)) (required)
- **available_webhook_set** (array (Webhook)) (required)
  Array items:
- **table_set** (array (ParserFieldDiet)) (required)
  Array items:
    - **id** (string) (required): ID
    - **name** (string) (required): name
- **emails_or_domains** (array (EmailOrDomain))

#### 403 - response

- **non_field_errors** (string) (required)

#### 404 - Not found

- **non_field_errors** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/parser/{id}"
```

```

--------------------------------

### Security: Authorization

Source: https://api.parseur.com/openapi.json

Use header: Authorization: Token YOUR_API_KEY. API keys are here: https://app.parseur.com/account/api-keys

```markdown
## Security: Authorization

**Description:** Use header: Authorization: Token YOUR_API_KEY. API keys are here: https://app.parseur.com/account/api-keys

**Type:** apiKey


```

--------------------------------

### Schema: Price

Source: https://api.parseur.com/openapi.json

Schema definition for Price

```markdown
## Schema: Price

Schema definition for Price

**Type:** object

- **id** (string) (required)
- **name** (string) (required)
- **interval** (string) (required)
- **interval_count** (integer) (required)
- **monthly_processed_document_max** (string) (required)
- **legacy** (boolean) (required)
- **price** (integer) (required)
- **currency** (object) (required)
  - **active** (boolean) (required)
  - **code** (string) (required)
  - **symbol** (string) (required)
  - **symbol_native** (string) (required)
  - **symbol_before** (string) (required)
  - **symbol_after** (string) (required)
  - **name** (string) (required)
  - **name_plural** (string) (required)
  - **decimal_digits** (integer) (required)
  - **template** (string) (required)
- **allow_transform** (boolean) (required)
- **allow_multiuser** (boolean) (required)
- **amount** (object) (required)
  - **decimal** (integer) (required)
  - **full** (integer) (required)
  - **major** (string) (required)
  - **minor** (string) (required)
  - **tag** (string) (required)
  - **tag_with_decimal** (string) (required)

```

--------------------------------

### GET /parser/{id}/document_set

Source: https://api.parseur.com/openapi.json

API endpoint for GET /parser/{id}/document_set

```markdown
### Parameters

- **id** (string, path, required)
- **page** (integer, query, optional): Page number for pagination (default is 1)
- **page_size** (integer, query, optional): Number of results per page (default is 25)
- **search** (string, query, optional): Case-insensitive partial match search
- **ordering** (string (name|-name|created|-created|processed|-processed|status|-status), query, optional): Field name to order by (use -prefix for descending)
- **received_after** (string (date), query, optional): Filter documents received after this date (yyyy-mm-dd)
- **received_before** (string (date), query, optional): Filter documents received before this date (yyyy-mm-dd)
- **status** (DocumentStatusEnum, query, optional): Filter documents by status
- **tz** (string, query, optional): Timezone for date filters (e.g. Asia%2FSingapore). Defaults to UTC.
- **with_result** (boolean, query, optional): Include parsed result string with each document

### Responses

#### 200 - List of documents (paginated)

- **count** (integer) (required)
- **current** (integer) (required)
- **total** (integer) (required)
- **results** (array (DocumentDiet)) (required)
  Array items:
    - **attached_to** (integer,null) (required)
    - **id** (integer) (required)
    - **match_master_template** (boolean) (required)
    - **name** (string) (required)
    - **ocr_ready_url** (string,null) (required)
    - **original_document_url** (string (uri)) (required)
    - **parser** (integer) (required)
    - **processed** (string (date-time)) (required)
    - **received** (string (date-time)) (required)
    - **sample_set** (array (TemplateSample)) (required)
    - **status_source** (string,null) (required) ("AI"|"AUTO"|"CSV"|"METADATA"|"MANUAL"|"TEMPLATE"|"TRANSFORM")
    - **status** (string (INCOMING|ANALYZING|PROGRESS|PARSEDOK|PARSEDKO|QUOTAEXC|SKIPPED|SPLIT|EXPORTKO|TRANSKO|INVALID)) (required) ("INCOMING"|"ANALYZING"|"PROGRESS"|"PARSEDOK"|"PARSEDKO"|"QUOTAEXC"|"SKIPPED"|"SPLIT"|"EXPORTKO"|"TRANSKO"|"INVALID")
    - **template** (integer,null) (required)
    - **credits_used** (integer) (required)
    - **conventional_credits_used** (integer) (required)
    - **ai_credits_used** (integer) (required)
    - **is_ai_ready** (boolean) (required)
    - **is_ocr_ready** (boolean) (required)
    - **is_processable** (boolean) (required)
    - **is_splittable** (boolean) (required)
    - **is_split** (boolean) (required)
    - **json_download_url** (string (uri)) (required)
    - **csv_download_url** (string (uri)) (required)
    - **xls_download_url** (string (uri)) (required)
    - **result** (string,null): Only present when using with_result=true query parameter

#### 403 - response

- **non_field_errors** (string) (required)

#### 404 - response

- **non_field_errors** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/parser/{id}/document_set?page=0&page_size=0&search=string&ordering=name&received_after=2023-01-01&received_before=2023-01-01&status=value&tz=string&with_result=true"
```

```

--------------------------------

### POST /document/{id}/process

Source: https://api.parseur.com/openapi.json

API endpoint for POST /document/{id}/process

```markdown
### Parameters

- **id** (string, path, required)

### Responses

#### 200 - Reprocessed

- **notification_set** (object) (required)
  - **info** (array (string)) (required)

#### 403 - response

- **non_field_errors** (string) (required)

#### 404 - response

- **non_field_errors** (string) (required)

### Example Usage

```bash
curl -X POST "https://api.example.com/document/{id}/process"
```

```

--------------------------------

### GET /document/{id}/log_set

Source: https://api.parseur.com/openapi.json

API endpoint for GET /document/{id}/log_set

```markdown
### Parameters

- **id** (string, path, required)
- **page** (integer, query, optional): Page number for pagination (default is 1)
- **page_size** (integer, query, optional): Number of results per page (default is 25)
- **search** (string, query, optional): Case-insensitive partial match search
- **ordering** (string, query, optional): Field name to order by (use -prefix for descending)

### Responses

#### 200 - List of document logs (paginated)

- **count** (integer) (required)
- **current** (integer) (required)
- **total** (integer) (required)
- **results** (array (Log)) (required)
  Array items:
    - **id** (integer) (required)
    - **created** (string (date-time)) (required)
    - **code** (string) (required)
    - **document** (integer) (required)
    - **document_name** (string) (required)
    - **parser** (integer) (required)
    - **parser_name** (string) (required)
    - **template** (integer,null) (required)
    - **template_name** (string,null) (required)
    - **status** (string (SUCCESS|ERROR|INFO|WARNING)) (required) ("SUCCESS"|"ERROR"|"INFO"|"WARNING")
    - **source** (string (DOCUMENT|OCRDOC|WEBHOOK)) (required) ("DOCUMENT"|"OCRDOC"|"WEBHOOK")
    - **payload** (string,null) (required)
    - **message** (string) (required)

#### 403 - response

- **non_field_errors** (string) (required)

#### 404 - response

- **non_field_errors** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/document/{id}/log_set?page=0&page_size=0&search=string&ordering=string"
```

```