> 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/northbeam/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidocs.polytomic.com/_mcp/server.

# Northbeam

Supports:
* ✅ Models
* ✅ Model sync destination
* ✅ Bulk sync source
* ✅ Connection Proxy


## Connection

### Configuration
<table>
<thead>
<tr>
<th>Name</th><th>Type</th><th>Description</th><th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>api_key</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">API key</td>
<td><code>required</code></td>
</tr>
<tr>
<td><code>data_client_id</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">Data client ID</td>
<td><code>required</code></td>
</tr>
<tr>
<td><code>instance</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">Instance<br/><br/>Accepted values: `prod`, `test`</td>
<td><code>required</code></td>
</tr>
</tbody>
</table>


#### Example

```json
{
  "name": "Northbeam connection",
  "type": "northbeam",
  "configuration": {
    "api_key": "",
    "data_client_id": "",
    "instance": "prod"
  }
}
```


## Model Sync
### Source
#### 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;">Object</td>
<td><code>required</code></td>
</tr>
</tbody>
</table>


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


### Target
Northbeam connections may be used as the destination in a model sync.







## Bulk Sync
### Source
Northbeam connections may be used as a bulk sync source. No additional configuration options are required.