# Output

Currently, there is only one way to send the output information to your systems. If you require an integration that you think should be supported out of the box, send your suggestion to Metamaze through the feedback button.

## REST API

{% hint style="info" %}
If you want to use IP allowlisting for your API, please allowlist the following IPs:

```
20.103.172.113 # Legacy Metamaze
52.232.77.70 # Legacy Metamaze
109.135.42.38 # Legacy Metamaze
37.139.2.18 # Legacy Metamaze
52.204.31.165 # Duco prod2
54.145.8.74 # Duco prod2
54.204.118.141 # Duco prod2
3.122.130.253 # Duco prod1
18.157.203.23 # Duco prod1
18.157.250.201 # Duco prod1
```

{% endhint %}

The REST API is a simple and flexible way to retrieve and use the extracted data in your own solutions. With this integration option, you can integrate with other tools & systems and streamline your workflow.

<figure><img src="/files/BtdD44SBbAIRnR95h0K0" alt=""><figcaption></figcaption></figure>

### API authentication method

| Setting                            | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API url                            | The API url to your system that will receive the output from Metamaze.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Export type                        | <p>You can export the data from Metamaze in the following formats out-of-the-box:</p><ul><li>JSON</li><li>CSV</li></ul><p><em>If a different format is required, our professional services team is available to assist, but additional fees may apply.</em></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Security protocol                  | <p>You can choose between the following protocols:</p><ul><li><strong>Token authentication</strong><br><em>You can configure the token, we will use this token to authorize our requests to your server</em></li><li><strong>Basic authentication</strong><br><em>Username and password are provided by you, we will use this to authorize our requests to your server</em></li><li><strong>SSL/TLS</strong><br><em>Certificate-based Mutual SSL authentication</em></li><li><p><strong>OAuth2</strong></p><ul><li><em>Token-based authentication for third-party applications, protecting user credentials</em></li></ul></li><li><strong>None</strong><br><em>strips all authentication HTTP headers</em> </li></ul> |
| Notify when validation is required | <p>When this option is enabled, the output webhook "<a href="https://app.metamaze.eu/docs/index.html#tag/Regular-processing/operation/ProcessDocumentsJobStatusAndResultsWebhook">ProcessDocumentsJobStatusAndResultsWebhook</a>" will be triggered when an upload requires validation.</p><p> </p>                                                                                                                                                                                                                                                                                                                                                                                                                    |

### Choose API version & include **extra** data in the output API call

| Setting                                                                                                     | Description                                                                                                                                                                                                                                                                                                                                                                                                                        |
| ----------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Version                                                                                                     | <p>The version of the API contract to use. We advise to always use the most recent one:</p><ul><li><strong>V2</strong><br><em>API documentation:</em><br><a href="https://app.metamaze.eu/docs/index.html"><em><https://app.metamaze.eu/docs/index.html></em></a></li><li><strong>V3</strong><br><em>API documentation:</em><br><a href="https://api.metamaze.eu/v3/docs"><em><https://api.metamaze.eu/v3/docs></em></a></li></ul> |
| The OCR'ed documents as \`processedPDF\`                                                                    | <p>This will include the document, that the OCR engine returned, in a base64 format as extra data in the output ("processedPDF")</p><p><br><em>(a link to the original uploaded file can always be found in our output)</em></p>                                                                                                                                                                                                   |
| Detected document language as \`language\`                                                                  | Include the detected language from the OCR for the document                                                                                                                                                                                                                                                                                                                                                                        |
| The reference (to annotation, document or different linked enrichment) from a linked enrichment as \`link\` | Include a reference to annotation, document or enrichment for enrichments.                                                                                                                                                                                                                                                                                                                                                         |
| The Outlook identifier of the upload as \`mailId\` (if the Outlook integration was enabled)                 | Include the outlook identifier when a mail was processed. This is handy when you want to perform custom actions with the email through a custom output or through an RPA platform.                                                                                                                                                                                                                                                 |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs-old.app.metamaze.eu/project/project-settings/output.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
