POpolytomic
Models

Enrichment Fields

Changed on

Returns the valid input field sets for an enrichment configuration on a connection.

When configuring an enrichment source in a model sync, use this endpoint to discover which input fields the enrichment connection requires. Pass the proposed enrichment configuration in the request body; the response lists the valid input field sets that map your model's fields to the enrichment service's expected inputs.

post/api/enrichment/{connection_id}/inputfields

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

connection_idstring uuid required

Enrichment connection ID

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Headers

X-Polytomic-Versionstring

Request body

configurationEnricherConfiguration

Similar to a model configuration, this configures the enricher. For example, if you wanted to use Apollo to enrich people, you would send {"object": "people"} as the configuration. Each enricher configuration can be found in the connection configuration docs.

Response

OK

Changes

  • 29735d6c9c02Revision changes
    • info

      added the non-success response with the status

  • 61c2b96f65baRevision changes
    • breaking

      added to the request property allOf list

    • breaking

      the request property type changed from object to no type