For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
GuidesAPI Reference
GuidesAPI Reference
  • API Reference
      • GETGet Enrichment Source
      • POSTEnrichment Fields
      • POSTPreview Model
      • GETList Models
      • POSTCreate Model
      • GETGet Model
      • PUTUpdate Model
      • DELDelete Model
      • GETSample Records
Logo
Log inBook a demo
API ReferenceModels

Get Enrichment Source

GET
https://app.polytomic.com/api/connections/:id/modelsync/enrichment-source
GET
/api/connections/:id/modelsync/enrichment-source
$curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/modelsync/enrichment-source \
>     -H "X-Polytomic-Version: X-Polytomic-Version" \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>"
1{
2  "data": {
3    "configuration": {},
4    "items": {},
5    "requires_one_of": [
6      "apiKey"
7    ]
8  }
9}
Describes the enrichment source configuration available on a connection. Not all connections support enrichment. Call this endpoint to determine whether a connection can serve as an enrichment source in a model sync and, if so, what configuration it accepts. > ⚠️ If the connection does not support enrichment, this endpoint returns > `404`. Check for that status before attempting to configure an enrichment > source on a sync. When a connection does support enrichment, the response describes the configuration fields required to set it up. Pass those values in the `enrichment` block when creating or updating a model sync.
Was this page helpful?
Previous

Enrichment Fields

Next

Describes the enrichment source configuration available on a connection.

Not all connections support enrichment. Call this endpoint to determine whether a connection can serve as an enrichment source in a model sync and, if so, what configuration it accepts.

⚠️ If the connection does not support enrichment, this endpoint returns 404. Check for that status before attempting to configure an enrichment source on a sync.

When a connection does support enrichment, the response describes the configuration fields required to set it up. Pass those values in the enrichment block when creating or updating a model sync.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"
Unique identifier of the connection.

Headers

X-Polytomic-VersionstringRequired

Query parameters

paramsmap from strings to lists of stringsOptional
Query parameters used to incrementally refine a dependent source configuration. Keys correspond to configuration fields returned by previous calls to this endpoint.

Response

OK
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error