Skip to navigation

Supports:

  • ✅ Models
  • ✅ Model sync destination
  • ✅ Bulk sync source
  • ✅ Connection Proxy

Connection

Configuration

NameTypeDescriptionRequired
api_keystringAPI key

The API key for your Plain machine user.
required
enforce_api_limitsbooleanEnforce API limits

If true, Polytomic will restrict itself to the per-minute cap of Plain API calls in minute_api_calls. ↓
optional
Read-only propertyTypeDescription
workspace_public_namestringWorkspace name

enforce_api_limits

When enforce_api_limits is true:

NameTypeDescriptionRequired
minute_api_callsintegerPer-minute call limit

The maximum number of Plain API calls Polytomic may make per minute across all syncs using this connection. Connection setup and health checks are excluded.
required
{
"name": "Plain connection",
"type": "plain",
"configuration": {
"api_key": "",
"enforce_api_limits": true,
"minute_api_calls": 0
}
}

Example

{
"name": "Plain connection",
"type": "plain",
"configuration": {
"api_key": "",
"enforce_api_limits": false
}
}

Model Sync

Source

Configuration

NameTypeDescriptionRequired
objectstringObjectrequired

Example

{
...
"configuration": {
"object": "object"
}
}

Target

Plain connections may be used as the destination in a model sync.

Bulk Sync

Source

Plain connections may be used as a bulk sync source. No additional configuration options are required.