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

# Clarify

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>environment</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">Environment<br/><br/>Accepted values: `production`, `development`, `custom` <a href="#environment-custom">↓</a></td>
<td><code>required</code></td>
</tr>
<tr>
<td><code>workspace</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">Workspace</td>
<td><code>required</code></td>
</tr>
</tbody>
</table>

<a id="environment-custom"></a>

#### `environment`

When `environment` is `custom`:

<table>
<thead>
<tr>
<th>Name</th><th>Type</th><th>Description</th><th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>server_url</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">Clarify API server URL</td>
<td><code>required</code></td>
</tr>
</tbody>
</table>

```json
{
  "name": "Clarify connection",
  "type": "clarify",
  "configuration": {
    "api_key": "",
    "environment": "custom",
    "server_url": "https://api.dev.clarify.ai",
    "workspace": "acme"
  }
}
```


#### Example

```json
{
  "name": "Clarify connection",
  "type": "clarify",
  "configuration": {
    "api_key": "",
    "environment": "production",
    "workspace": "acme"
  }
}
```


## 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
Clarify connections may be used as the destination in a model sync.
#### All targets

##### Configuration
<table>
<thead>
<tr>
<th>Name</th><th>Type</th><th>Description</th><th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>invalid_relationships</code></td>
<td><code>string</code></td>
<td style="vertical-align: top;">Records with invalid relationship IDs<br/><br/>Accepted values: `error`, `omit_values`, `omit_records`</td>
<td><code>required</code></td>
</tr>
<tr>
<td><code>write_null_values</code></td>
<td><code>boolean</code></td>
<td style="vertical-align: top;">Copy null values</td>
<td><code>optional</code></td>
</tr>
</tbody>
</table>


##### Example
```json
{
  ...
  "target": {
      "configuration": {
        "invalid_relationships": "error",
        "write_null_values": false
    }
  }
}
```









## Bulk Sync
### Source
#### Configuration
<table>
<thead>
<tr>
<th>Name</th><th>Type</th><th>Description</th><th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>include_archived</code></td>
<td><code>boolean</code></td>
<td style="vertical-align: top;">Include archived Clarify records</td>
<td><code>optional</code></td>
</tr>
</tbody>
</table>


#### Example
```json
{
  ...
  "source_configuration": {
    "include_archived": false
  }
}
```