> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://apidocs.polytomic.com/2024-02-08/guides/configuring-your-connections/connections/httpenrichment/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidocs.polytomic.com/_mcp/server.

# HTTP Enrichment

Supports:
* ✅ Enrichment


## Connection

### Configuration
<table>
<thead>
<tr>
<th>Name</th><th>Type</th><th>Description</th><th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>auth</code></td>
<td><code>object</code></td>
<td style="vertical-align: top;">Authentication method</td>
<td><code>optional</code></td>
</tr>
<tr>
<td><code>body</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">JSON payload</td>
<td><code>optional</code></td>
</tr>
<tr>
<td><code>example_body</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">Example body to be saved with the query</td>
<td><code>optional</code></td>
</tr>
<tr>
<td><code>example_inputs</code></td>
<td><code>object</code></td>
<td style="vertical-align: top;">Example inputs to be saved with the connection</td>
<td><code>optional</code></td>
</tr>
<tr>
<td><code>fields</code></td>
<td><code>array</code></td>
<td style="vertical-align: top;">Fields<br/><br/>List of fields to be returned by the enrichment</td>
<td><code>optional</code></td>
</tr>
<tr>
<td><code>headers</code></td>
<td><code>array</code></td>
<td style="vertical-align: top;">Headers</td>
<td><code>optional</code></td>
</tr>
<tr>
<td><code>healthcheck</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">Health check endpoint<br/><br/>Path to request when checking the health of this connection. No health check will be performed if left empty.</td>
<td><code>optional</code></td>
</tr>
<tr>
<td><code>inputMappings</code></td>
<td><code>array</code></td>
<td style="vertical-align: top;">Input mappings<br/><br/>List of input mappings to be used in the query. Each mapping should be a valid JSONPath expression.</td>
<td><code>optional</code></td>
</tr>
<tr>
<td><code>method</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">HTTP method<br/><br/>Accepted values: `GET`, `POST`</td>
<td><code>required</code></td>
</tr>
<tr>
<td><code>parameters</code></td>
<td><code>array</code></td>
<td style="vertical-align: top;">Query string parameters</td>
<td><code>optional</code></td>
</tr>
<tr>
<td><code>url</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">Base URL</td>
<td><code>required</code></td>
</tr>
</tbody>
</table>


#### Example

```json
{
  "name": "HTTP Enrichment connection",
  "type": "httpenrichment",
  "configuration": {
    "auth": {
        "basic": {
            "password": "secret",
            "username": "user@example.com"
        },
        "header": {
            "name": "foo",
            "value": "bar"
        },
        "oauth": {
            "auth_style": 0,
            "client_id": "client_id",
            "client_secret": "client_secret",
            "extra_form_data": [
                {
                    "name": "foo",
                    "value": "bar"
                }
            ],
            "scopes": [],
            "token_endpoint": "https://example.com/oauth/token"
        },
        "query": [
            {
                "name": "foo",
                "value": "bar"
            }
        ]
    },
    "body": "{\"key\":\"value\"}",
    "example_body": "",
    "example_inputs": {},
    "fields": [
        {
            "name": "",
            "path": "",
            "type": ""
        }
    ],
    "headers": [
        {
            "name": "foo",
            "value": "bar"
        }
    ],
    "healthcheck": "https://example.com/healthz",
    "inputMappings": [
        {
            "name": "",
            "required": false,
            "type": ""
        }
    ],
    "method": "GET",
    "parameters": [
        {
            "name": "foo",
            "value": "bar"
        }
    ],
    "url": "https://example.com"
  }
}
```


## Model Sync
### Enrichment
#### Configuration
<table>
<thead>
<tr>
<th>Name</th><th>Type</th><th>Description</th><th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>object</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;"></td>
<td><code>optional</code></td>
</tr>
</tbody>
</table>


#### Example
```json
{
  ...
  "configuration": {
    "object": ""
  }
}
```