dochorizon_capture_bank_statement

SPENDS CREDITS: extract a bank statement: bank, account holder, period, opening and closing balance and every transaction. WARNING: the result contains personal data of the people on the document; handle it accordingly. It is returned to you only; this server never stores or logs it. Uses your own Doxis AI.dp (Klippa) credits: billed per request or per page depending on the service (extra components in a configuration can add cost), at your project's price (Billing → Pricing in the platform); a new account starts with EUR 25 of free credit. Give the document as exactly one of url (public https), data_base64 (small files) or file_id (a stored file). POST /document_capturing/v1/bank_statement.

Argument	Type	Description
url	string	Public https URL of the document. Klippa downloads it (must complete within 30 seconds).
file_id	string	A Doxis AI.dp storage file id (from dochorizon_upload_file or a toolkit result).
filename	string	A name for the file (helps content-type detection).
password	string	Password of a protected PDF. Only used for this request.
data_base64	string	The document as base64 (at most about 1.5 MB of file). Prefer url or file_id for anything bigger.
page_ranges	string	Pages to process, for example '1-3, 5', '2-last', 'first-last' (default: all pages; documents over 50 pages time out).
content_type	string	MIME type, if it cannot be detected.
configuration_slug	string	Slug of a capturing configuration made in the platform (see dochorizon_list_configurations). Optional: the model's defaults apply without it.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 2048,
      "description": "Public https URL of the document. Klippa downloads it (must complete within 30 seconds)."
    },
    "file_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "A Doxis AI.dp storage file id (from dochorizon_upload_file or a toolkit result)."
    },
    "filename": {
      "type": "string",
      "maxLength": 255,
      "description": "A name for the file (helps content-type detection)."
    },
    "password": {
      "type": "string",
      "maxLength": 200,
      "description": "Password of a protected PDF. Only used for this request."
    },
    "data_base64": {
      "type": "string",
      "maxLength": 2000200,
      "description": "The document as base64 (at most about 1.5 MB of file). Prefer url or file_id for anything bigger."
    },
    "page_ranges": {
      "type": "string",
      "maxLength": 100,
      "description": "Pages to process, for example '1-3, 5', '2-last', 'first-last' (default: all pages; documents over 50 pages time out)."
    },
    "content_type": {
      "type": "string",
      "pattern": "^[\\w.+-]+\\/[\\w.+-]+$",
      "maxLength": 100,
      "description": "MIME type, if it cannot be detected."
    },
    "configuration_slug": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.-]+$",
      "maxLength": 100,
      "minLength": 1,
      "description": "Slug of a capturing configuration made in the platform (see dochorizon_list_configurations). Optional: the model's defaults apply without it."
    }
  }
}

dochorizon_capture_einvoice

SPENDS CREDITS: read an invoice with the financial model and return it in the Universal Invoice structure used for e-invoicing (parties, lines, tax subtotals, totals, payment means). Does not send anything to a network. Uses your own Doxis AI.dp (Klippa) credits: billed per request or per page depending on the service (extra components in a configuration can add cost), at your project's price (Billing → Pricing in the platform); a new account starts with EUR 25 of free credit. Give the document as exactly one of url (public https), data_base64 (small files) or file_id (a stored file). POST /document_capturing/v1/einvoice.

Argument	Type	Description
url	string	Public https URL of the document. Klippa downloads it (must complete within 30 seconds).
file_id	string	A Doxis AI.dp storage file id (from dochorizon_upload_file or a toolkit result).
filename	string	A name for the file (helps content-type detection).
password	string	Password of a protected PDF. Only used for this request.
data_base64	string	The document as base64 (at most about 1.5 MB of file). Prefer url or file_id for anything bigger.
page_ranges	string	Pages to process, for example '1-3, 5', '2-last', 'first-last' (default: all pages; documents over 50 pages time out).
content_type

dochorizon_capture_financial

SPENDS CREDITS: extract structured data from an invoice, receipt or other financial document with the Financial model: merchant and customer, dates, totals, VAT, line items, payment details, currency, and more (as the chosen configuration enables). Uses your own Doxis AI.dp (Klippa) credits: billed per request or per page depending on the service (extra components in a configuration can add cost), at your project's price (Billing → Pricing in the platform); a new account starts with EUR 25 of free credit. Give the document as exactly one of url (public https), data_base64 (small files) or file_id (a stored file). Synchronous; for long documents use dochorizon_submit_async_capture. POST /document_capturing/v1/financial.

Argument	Type	Description
url	string	Public https URL of the document. Klippa downloads it (must complete within 30 seconds).
file_id	string	A Doxis AI.dp storage file id (from dochorizon_upload_file or a toolkit result).
filename	string	A name for the file (helps content-type detection).
password	string	Password of a protected PDF. Only used for this request.
data_base64	string	The document as base64 (at most about 1.5 MB of file). Prefer url or file_id for anything bigger.
page_ranges	string	Pages to process, for example '1-3, 5', '2-last', 'first-last' (default: all pages; documents over 50 pages time out).

dochorizon_capture_generic

SPENDS CREDITS: turn any document into generic structured data: key-value pairs and tables, as JSON. Uses your own Doxis AI.dp (Klippa) credits: billed per request or per page depending on the service (extra components in a configuration can add cost), at your project's price (Billing → Pricing in the platform); a new account starts with EUR 25 of free credit. Give the document as exactly one of url (public https), data_base64 (small files) or file_id (a stored file). POST /document_capturing/v1/generic.

Argument	Type	Description
url	string	Public https URL of the document. Klippa downloads it (must complete within 30 seconds).
file_id	string	A Doxis AI.dp storage file id (from dochorizon_upload_file or a toolkit result).
filename	string	A name for the file (helps content-type detection).
password	string	Password of a protected PDF. Only used for this request.
data_base64	string	The document as base64 (at most about 1.5 MB of file). Prefer url or file_id for anything bigger.
page_ranges	string	Pages to process, for example '1-3, 5', '2-last', 'first-last' (default: all pages; documents over 50 pages time out).
content_type	string	MIME type, if it cannot be detected.

dochorizon_capture_identity

SPENDS CREDITS: read an identity document (passport, ID card, driver's licence, visa) with the Identity model: name, date of birth, nationality, document number, expiry, MRZ, validity and fraud checks. WARNING: the result contains personal data of the people on the document; handle it accordingly. It is returned to you only; this server never stores or logs it. Uses your own Doxis AI.dp (Klippa) credits: billed per request or per page depending on the service (extra components in a configuration can add cost), at your project's price (Billing → Pricing in the platform); a new account starts with EUR 25 of free credit. Give the document as exactly one of url (public https), data_base64 (small files) or file_id (a stored file). Images up to 4096 px per side. POST /document_capturing/v1/identity.

Argument	Type	Description
url	string	Public https URL of the document. Klippa downloads it (must complete within 30 seconds).
file_id	string	A Doxis AI.dp storage file id (from dochorizon_upload_file or a toolkit result).
filename	string	A name for the file (helps content-type detection).
password	string	Password of a protected PDF. Only used for this request.
data_base64	string	The document as base64 (at most about 1.5 MB of file). Prefer url or file_id for anything bigger.
page_ranges	string	Pages to process, for example '1-3, 5', '2-last', 'first-last' (default: all pages; documents over 50 pages time out).

dochorizon_capture_salary_slip

SPENDS CREDITS: extract a salary slip (payslip): employer, employee, period, gross and net pay, deductions. WARNING: the result contains personal data of the people on the document; handle it accordingly. It is returned to you only; this server never stores or logs it. Uses your own Doxis AI.dp (Klippa) credits: billed per request or per page depending on the service (extra components in a configuration can add cost), at your project's price (Billing → Pricing in the platform); a new account starts with EUR 25 of free credit. Give the document as exactly one of url (public https), data_base64 (small files) or file_id (a stored file). POST /document_capturing/v1/salary_slip.

Argument	Type	Description
url	string	Public https URL of the document. Klippa downloads it (must complete within 30 seconds).
file_id	string	A Doxis AI.dp storage file id (from dochorizon_upload_file or a toolkit result).
filename	string	A name for the file (helps content-type detection).
password	string	Password of a protected PDF. Only used for this request.
data_base64	string	The document as base64 (at most about 1.5 MB of file). Prefer url or file_id for anything bigger.
page_ranges	string	Pages to process, for example '1-3, 5', '2-last', 'first-last' (default: all pages; documents over 50 pages time out).

dochorizon_capture_with_prompt

SPENDS CREDITS: extract data from a document with a Prompt Builder configuration (an LLM extraction prompt you defined in the platform). Output follows that configuration's schema (see dochorizon_get_prompt_schema). The result may contain whatever personal data the document holds. Uses your own Doxis AI.dp (Klippa) credits: billed per request or per page depending on the service (extra components in a configuration can add cost), at your project's price (Billing → Pricing in the platform); a new account starts with EUR 25 of free credit. Give the document as exactly one of url (public https), data_base64 (small files) or file_id (a stored file). POST /document_capturing/v1/prompt_builder/configurations/{slug}.

Argument	Type	Description
url	string	Public https URL of the document. Klippa downloads it (must complete within 30 seconds).
slug*	string	Prompt Builder configuration slug (see dochorizon_list_prompt_configurations).
file_id	string	A Doxis AI.dp storage file id (from dochorizon_upload_file or a toolkit result).
filename	string	A name for the file (helps content-type detection).
password	string	Password of a protected PDF. Only used for this request.
data_base64	string	The document as base64 (at most about 1.5 MB of file). Prefer url or file_id for anything bigger.

dochorizon_convert_einvoice

Convert an e-invoice (XML or hybrid PDF) to the Universal Invoice JSON structure (parties, lines, taxes, totals). Nothing is sent to anyone. May use credits per your pricing. POST /einvoicing/v1/tools/convert/einvoice.

Argument	Type	Description
xml	string	The e-invoice as XML text (UBL, CII, ...).
validate	boolean	Validate the e-invoice during conversion.
data_base64	string	The e-invoice file as base64 (XML, or a hybrid PDF such as ZUGFeRD / Factur-X).
einvoice_type	string	The e-invoice type, if it should not be auto-detected (see dochorizon_list_einvoice_types).
include_unmapped_fields	boolean	Also return fields of the original that have no place in the universal format.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "xml": {
      "type": "string",
      "maxLength": 1000000,
      "description": "The e-invoice as XML text (UBL, CII, ...)."
    },
    "validate": {
      "type": "boolean",
      "description": "Validate the e-invoice during conversion."
    },
    "data_base64": {
      "type": "string",
      "maxLength": 2000200,
      "description": "The e-invoice file as base64 (XML, or a hybrid PDF such as ZUGFeRD / Factur-X)."
    },
    "einvoice_type": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "maxLength": 60,
      "description": "The e-invoice type, if it should not be auto-detected (see dochorizon_list_einvoice_types)."
    },
    "include_unmapped_fields": {
      "type": "boolean",
      "description": "Also return fields of the original that have no place in the universal format."
    }
  }
}

dochorizon_delete_async_job

WRITE: permanently delete an async job, its result and the stored documents from Doxis AI.dp's servers; a job still waiting in the queue is cancelled. Use it to remove personal data you no longer need. Cannot be undone. DELETE /document_capturing/v1/async/{job_id}.

destructive

Argument	Type	Description
job_id*	string	The job_id returned when the document was submitted.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id"
  ],
  "properties": {
    "job_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "The job_id returned when the document was submitted."
    }
  }
}

dochorizon_document_info

SPENDS CREDITS: page count, page sizes, content type, metadata and permissions of a PDF or TIFF. Useful to check the page count before capturing. Uses your own Doxis AI.dp (Klippa) credits: billed per request or per page depending on the service (extra components in a configuration can add cost), at your project's price (Billing → Pricing in the platform); a new account starts with EUR 25 of free credit. Give the document as exactly one of url (public https), data_base64 (small files) or file_id (a stored file). POST /document_toolkit/v1/info.

Argument	Type	Description
url	string	Public https URL of the document. Klippa downloads it (must complete within 30 seconds).
file_id	string	A Doxis AI.dp storage file id (from dochorizon_upload_file or a toolkit result).
filename	string	A name for the file (helps content-type detection).
password	string	Password of a protected PDF. Only used for this request.
data_base64	string	The document as base64 (at most about 1.5 MB of file). Prefer url or file_id for anything bigger.
content_type	string	MIME type, if it cannot be detected.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 2048,
      "description": "Public https URL of the document. Klippa downloads it (must complete within 30 seconds)."
    },
    "file_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "A Doxis AI.dp storage file id (from dochorizon_upload_file or a toolkit result)."
    },
    "filename": {
      "type": "string",
      "maxLength": 255,
      "description": "A name for the file (helps content-type detection)."
    },
    "password": {
      "type": "string",
      "maxLength": 200,
      "description": "Password of a protected PDF. Only used for this request."
    },
    "data_base64": {
      "type": "string",
      "maxLength": 2000200,
      "description": "The document as base64 (at most about 1.5 MB of file). Prefer url or file_id for anything bigger."
    },
    "content_type": {
      "type": "string",
      "pattern": "^[\\w.+-]+\\/[\\w.+-]+$",
      "maxLength": 100,
      "description": "MIME type, if it cannot be detected."
    }
  }
}

dochorizon_document_merge

SPENDS CREDITS: merge two or more PDFs into one, in the order given, optionally taking only some pages of each. The merged file is stored in Doxis AI.dp storage and returned as a file id. Uses your own Doxis AI.dp (Klippa) credits: billed per request or per page depending on the service (extra components in a configuration can add cost), at your project's price (Billing → Pricing in the platform); a new account starts with EUR 25 of free credit. Each document is one of url (public https), data_base64 or file_id. POST /document_toolkit/v1/merge.

Argument	Type	Description
documents*	array	The PDFs to merge, in order (2 to 10).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "documents"
  ],
  "properties": {
    "documents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "maxLength": 2048,
            "description": "Public https URL of the document. Klippa downloads it (must complete within 30 seconds)."
          },
          "file_id": {
            "type": "string",
            "maxLength": 200,
            "minLength": 1,
            "description": "A Doxis AI.dp storage file id (from dochorizon_upload_file or a toolkit result)."
          },
          "filename": {
            "type": "string",
            "maxLength": 255,
            "description": "A name for the file (helps content-type detection)."
          },
          "password": {
            "type": "string",
            "maxLength": 200,
            "description": "Password of a protected PDF. Only used for this request."
          },
          "data_base64": {
            "type": "string",
            "maxLength": 2000200,
            "description": "The document as base64 (at most about 1.5 MB of file). Prefer url or file_id for anything bigger."
          },
          "page_ranges": {
            "type": "array",
            "items": {
              "type": "string",
              "pattern": "^[A-Za-z0-9,\\- ]+$",
              "maxLength": 100
            },
            "maxItems": 20,
            "description": "Only these pages of this document, e.g. ['1-2']. Default: all."
          }
        }
      },
      "maxItems": 10,
      "minItems": 2,
      "description": "The PDFs to merge, in order (2 to 10)."
    }
  }
}

dochorizon_document_render

SPENDS CREDITS: render pages of a PDF as images, optionally limited in width/height. Each render config gives page_ranges and optional width and height in pixels. Images are stored in Doxis AI.dp storage and returned as file ids (use dochorizon_download_file for small ones). Uses your own Doxis AI.dp (Klippa) credits: billed per request or per page depending on the service (extra components in a configuration can add cost), at your project's price (Billing → Pricing in the platform); a new account starts with EUR 25 of free credit. Give the document as exactly one of url (public https), data_base64 (small files) or file_id (a stored file). POST /document_toolkit/v1/render.

Argument	Type	Description
url	string	Public https URL of the document. Klippa downloads it (must complete within 30 seconds).
file_id	string	A Doxis AI.dp storage file id (from dochorizon_upload_file or a toolkit result).
renders*	array	The render configurations.
filename	string	A name for the file (helps content-type detection).
password	string	Password of a protected PDF. Only used for this request.
data_base64	string	The document as base64 (at most about 1.5 MB of file). Prefer url or file_id for anything bigger.
content_type

dochorizon_document_split

SPENDS CREDITS: split a PDF into several PDFs by page ranges (one output file per range, for example ['1-3','4-6']). Output files are stored in Doxis AI.dp storage and returned as file ids you can pass to any other tool as file_id. Uses your own Doxis AI.dp (Klippa) credits: billed per request or per page depending on the service (extra components in a configuration can add cost), at your project's price (Billing → Pricing in the platform); a new account starts with EUR 25 of free credit. Give the document as exactly one of url (public https), data_base64 (small files) or file_id (a stored file). POST /document_toolkit/v1/split.

Argument	Type	Description
url	string	Public https URL of the document. Klippa downloads it (must complete within 30 seconds).
file_id	string	A Doxis AI.dp storage file id (from dochorizon_upload_file or a toolkit result).
filename	string	A name for the file (helps content-type detection).
password	string	Password of a protected PDF. Only used for this request.
data_base64	string	The document as base64 (at most about 1.5 MB of file). Prefer url or file_id for anything bigger.
page_ranges*	array	One entry per output file, e.g. ['1-3', '4-6', '7'].
content_type	string

dochorizon_download_file

Fetch a stored file by file_id and return it as base64. Only files up to 30 KB are returned inline; for larger files use the file_id in other tools instead. Does not process a document; normally not billed. GET /storage/v1/files/{file_id}.

read-only

Argument	Type	Description
file_id*	string	A storage file id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "file_id"
  ],
  "properties": {
    "file_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "A storage file id."
    }
  }
}

dochorizon_get_async_job

The status of one async capture job (in_queue, processing, hitl, done, error, closed, rejected). Does not process a document; normally not billed. GET /document_capturing/v1/async/{job_id}.

read-only

Argument	Type	Description
job_id*	string	The job_id returned when the document was submitted.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id"
  ],
  "properties": {
    "job_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "The job_id returned when the document was submitted."
    }
  }
}

dochorizon_get_async_job_logs

Status changes and error messages of an async job, to debug a failed one. Does not process a document; normally not billed. GET /document_capturing/v1/async/{job_id}/logs.

read-only

Argument	Type	Description
limit	integer	Entries per page (default 25).
job_id*	string	The job_id returned when the document was submitted.
offset	integer	Skip this many entries.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Entries per page (default 25)."
    },
    "job_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "The job_id returned when the document was submitted."
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Skip this many entries."
    }
  }
}

dochorizon_get_async_job_result

The captured data of a finished async job (status done). The result may contain personal data (identity, salary slip, bank statement). Does not process a document; normally not billed. GET /document_capturing/v1/async/{job_id}/result.

read-only

Argument	Type	Description
job_id*	string	The job_id returned when the document was submitted.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id"
  ],
  "properties": {
    "job_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "The job_id returned when the document was submitted."
    }
  }
}

dochorizon_get_key_info

Check the connected Doxis AI.dp (Klippa DocHorizon) API key: organization, project, credential id, and the services enabled for it. Does not process a document and costs nothing. GET /auth/v1/info.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

dochorizon_get_model_schema

The JSON schema of what a capturing model returns (every field it can extract), optionally for one configuration. Does not process a document; normally not billed. GET /document_capturing/v1/{model}/schema or /{model}/configurations/{slug}/schema.

read-only

Argument	Type	Description
model*	string	The capturing model.
configuration_slug	string	Schema for this configuration (not for einvoice).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "model"
  ],
  "properties": {
    "model": {
      "enum": [
        "financial",
        "identity",
        "bank_statement",
        "salary_slip",
        "einvoice"
      ],
      "type": "string",
      "description": "The capturing model."
    },
    "configuration_slug": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.-]+$",
      "maxLength": 100,
      "minLength": 1,
      "description": "Schema for this configuration (not for einvoice)."
    }
  }
}

dochorizon_get_prompt_schema

The JSON schema of the output of one Prompt Builder configuration. Does not process a document; normally not billed. GET /document_capturing/v1/prompt_builder/configurations/{slug}/schema.

read-only

Argument	Type	Description
slug*	string	Prompt Builder configuration slug.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "slug"
  ],
  "properties": {
    "slug": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.-]+$",
      "maxLength": 100,
      "minLength": 1,
      "description": "Prompt Builder configuration slug."
    }
  }
}

dochorizon_list_async_jobs

List the project's async capture jobs (newest first as returned): job_id, status, created time, with paging. Does not process a document; normally not billed. GET /document_capturing/v1/async.

read-only

Argument	Type	Description
limit	integer	Jobs per page (default 25).
offset	integer	Skip this many jobs (use the previous reply's paging_data).
status	array	Only jobs in these states.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Jobs per page (default 25)."
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Skip this many jobs (use the previous reply's paging_data)."
    },
    "status": {
      "type": "array",
      "items": {
        "enum": [
          "in_queue",
          "processing",
          "hitl",
          "done",
          "error",
          "closed",
          "rejected"
        ],
        "type": "string"
      },
      "maxItems": 7,
      "description": "Only jobs in these states."
    }
  }
}

dochorizon_list_configurations

List the capturing configurations of a model (name, slug and the enabled components). Pass a slug as configuration_slug to a capture tool to choose which fields are extracted. Does not process a document; normally not billed. GET /document_capturing/v1/{model}/configurations.

read-only

Argument	Type	Description
model*	string	The capturing model.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "model"
  ],
  "properties": {
    "model": {
      "enum": [
        "financial",
        "identity",
        "bank_statement",
        "salary_slip"
      ],
      "type": "string",
      "description": "The capturing model."
    }
  }
}

dochorizon_list_einvoice_types

The e-invoice types Doxis AI.dp understands (ids to pass as einvoice_type). Does not process a document; normally not billed. GET /einvoicing/v1/tools/einvoice-types.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

dochorizon_list_models

List the document capturing models enabled for this project (financial, identity, bank statement, salary slip, generic, e-invoice, ...). Does not process a document; normally not billed. GET /document_capturing/v1/enabled_models.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

dochorizon_list_prompt_configurations

List the Prompt Builder (LLM extraction) configurations of the project: name and slug. Does not process a document; normally not billed. GET /document_capturing/v1/prompt_builder/configurations.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

dochorizon_lookup_peppol_participant

Look up one Peppol participant by identifier (for example iso6523-actorid-upis::0106:64111512) in the Peppol network (SML): the document types it can receive. Does not process a document; normally not billed. GET /einvoicing/v1/peppol/environments/{environment}/participants/{participant_identifier}.

read-only

Argument	Type	Description
environment	string	Peppol environment: production (live network) or acceptance (test).
participant_identifier*	string	The Peppol participant identifier.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "participant_identifier"
  ],
  "properties": {
    "environment": {
      "enum": [
        "production",
        "acceptance"
      ],
      "type": "string",
      "description": "Peppol environment: production (live network) or acceptance (test)."
    },
    "participant_identifier": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "maxLength": 200,
      "minLength": 3,
      "description": "The Peppol participant identifier."
    }
  }
}

dochorizon_search_peppol_directory

Search the public Peppol business directory by company name, identifier or other text: participant identifiers, countries, contacts, websites and the document types each can receive. Public business data; costs nothing. GET /einvoicing/v1/peppol/environments/{environment}/directory.

read-only

Argument	Type	Description
query*	string	Name, identifier or other identifying text.
environment	string	Peppol environment: production (live network) or acceptance (test).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "query"
  ],
  "properties": {
    "query": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Name, identifier or other identifying text."
    },
    "environment": {
      "enum": [
        "production",
        "acceptance"
      ],
      "type": "string",
      "description": "Peppol environment: production (live network) or acceptance (test)."
    }
  }
}

dochorizon_submit_async_capture

SPENDS CREDITS: queue one document for capturing and return a job_id right away; poll dochorizon_get_async_job, then read dochorizon_get_async_job_result. Use it for long documents and bursts (async jobs are not subject to the concurrent-request limit). No webhook or human review is configured. For identity, salary_slip and bank_statement the result holds personal data. Uses your own Doxis AI.dp (Klippa) credits: billed per request or per page depending on the service (extra components in a configuration can add cost), at your project's price (Billing → Pricing in the platform); a new account starts with EUR 25 of free credit. Give the document as exactly one of url (public https), data_base64 (small files) or file_id (a stored file). POST /document_capturing/v1/{model}/async.

Argument	Type	Description
url	string	Public https URL of the document. Klippa downloads it (must complete within 30 seconds).
model*	string	The capturing model.
file_id	string	A Doxis AI.dp storage file id (from dochorizon_upload_file or a toolkit result).
filename	string	A name for the file (helps content-type detection).
password	string	Password of a protected PDF. Only used for this request.
data_base64	string	The document as base64 (at most about 1.5 MB of file). Prefer url or file_id for anything bigger.

dochorizon_upload_file

WRITE: store a file in your Doxis AI.dp storage and get a file_id to reuse in other tools (capture the same file several times without sending it again). Give a public https url or small base64 data. The file stays in your project's storage until it expires per your data-retention setting. May use credits per your pricing. POST /storage/v1/files.

Argument	Type	Description
url	string	Public https URL of the document. Klippa downloads it (must complete within 30 seconds).
filename	string	A name for the file (helps content-type detection).
data_base64	string	The document as base64 (at most about 1.5 MB of file). Prefer url or file_id for anything bigger.
content_type	string	MIME type, if it cannot be detected.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 2048,
      "description": "Public https URL of the document. Klippa downloads it (must complete within 30 seconds)."
    },
    "filename": {
      "type": "string",
      "maxLength": 255,
      "description": "A name for the file (helps content-type detection)."
    },
    "data_base64": {
      "type": "string",
      "maxLength": 2000200,
      "description": "The document as base64 (at most about 1.5 MB of file). Prefer url or file_id for anything bigger."
    },
    "content_type": {
      "type": "string",
      "pattern": "^[\\w.+-]+\\/[\\w.+-]+$",
      "maxLength": 100,
      "description": "MIME type, if it cannot be detected."
    }
  }
}

dochorizon_validate_einvoice

Validate an e-invoice (XML or hybrid PDF) against its standard (EN 16931, XRechnung, Peppol BIS, ...): returns the detected type, valid yes/no, a summary and each broken rule with its XPath location. Nothing is sent to anyone. May use credits per your pricing. POST /einvoicing/v1/tools/validate.

Argument	Type	Description
xml	string	The e-invoice as XML text (UBL, CII, ...).
data_base64	string	The e-invoice file as base64 (XML, or a hybrid PDF such as ZUGFeRD / Factur-X).
einvoice_type	string	The e-invoice type, if it should not be auto-detected (see dochorizon_list_einvoice_types).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "xml": {
      "type": "string",
      "maxLength": 1000000,
      "description": "The e-invoice as XML text (UBL, CII, ...)."
    },
    "data_base64": {
      "type": "string",
      "maxLength": 2000200,
      "description": "The e-invoice file as base64 (XML, or a hybrid PDF such as ZUGFeRD / Factur-X)."
    },
    "einvoice_type": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.:-]+$",
      "maxLength": 60,
      "description": "The e-invoice type, if it should not be auto-detected (see dochorizon_list_einvoice_types)."
    }
  }
}

Doxis AI.dp (Klippa DocHorizon) MCP by usefulapi

Try it

dochorizon_capture_bank_statement

Doxis AI.dp (Klippa DocHorizon) MCP by usefulapi

Try it

dochorizon_capture_bank_statement

Tools (30)