Get Configuration API

Learn how to retrieve the Autopilot configuration for a tenant.

Use get configuration API to retrieve the current active Autopilot configuration for a tenant. The response includes default settings and any lookup type-specific overrides that control Autopilot behavior.

HTTP method and endpoint

Use the following HTTP method and endpoint path to submit the request:

GET /configuration/{tenantId}/autopilot

Endpoint path parameters

The following table describes the endpoint path parameters.


Parameter	Type	Required	Description
`tenantId`	String	Yes	Tenant identifier

Request headers

The following request headers must be included.


Header	Value	Required
`Authorization`	Bearer {token}	Yes

Request body

This operation does not require a request body.

Response body

The following table describes the fields returned in the response body.


Field	Type	Description
`tenantId`	String	The identifier of the tenant.
`updatedBy`	String	The identifier of the user who last updated the configuration.
`updateDate`	Number	The timestamp of the last update, in epoch milliseconds.
`version`	Integer	The version of the Autopilot configuration.
`defaults`	Object	Contains tenant-level default Autopilot settings.
`enabled`	Boolean	Indicates whether Autopilot processing is enabled "or not" replaced by default.
`mode`	String	Specifies the default processing mode.
`misspelledThreshold`	Number	Defines the threshold for misspelled value handling.
`autoMapThreshold`	Number	Defines the threshold for automatic mapping.
`suggestionThreshold`	Number	Defines the threshold for suggestion generation.
`requiredFrequency`	Integer	Specifies the required number of occurrences before action.
`frequencyWindowHours`	Integer	Specifies the frequency evaluation window in hours.
`autoMapEnabled`	Boolean	Indicates whether automatic mapping is enabled by default.
`suggestionEnabled`	Boolean	Indicates whether suggestions are enabled by default.
`createLookupEnabled`	Boolean	Indicates whether lookup creation is enabled by default.
`suggestLookupEnabled`	Boolean	Indicates whether lookup suggestions are enabled.
`createLookupThreshold`	Number	Defines the threshold for lookup creation.
`suggestLookupThreshold`	Number	Defines the threshold for lookup suggestion.
`lookupTypes`	Array	List of lookup type–specific configuration entries.
`uri`	String	The URI of the lookup type.
`settings`	Object	Contains configuration settings for the lookup type.
`enabled`	Boolean	Indicates whether Autopilot processing is enabled for the lookup type.
`mode`	String	Specifies the processing mode for the lookup type.
`autoMapThreshold`	Number	Defines the threshold for automatic mapping.
`suggestionThreshold`	Number	Defines the threshold for suggestion generation.
`requiredFrequency`	Integer	Specifies the required number of occurrences before action.

Example response

The following example shows a response containing the Autopilot configuration.

{
  "tenantId": "my_tenant",
  "updatedBy": "admin@company.com",
  "updateDate": 1704153600000,
  "version": 3,
  "defaults": {
    "enabled": true,
    "mode": "ACTIVE",
    "autoMapEnabled": true,
    "autoMapThreshold": 0.90,
    "suggestionEnabled": true,
    "suggestionThreshold": 0.75,
    "createLookupEnabled": false,
    "createLookupThreshold": 0.90,
    "suggestLookupEnabled": false,
    "suggestLookupThreshold": 0.75,
    "misspelledThreshold": 0.85,
    "requiredFrequency": 10,
    "frequencyWindowHours": 24
  },
  "lookupTypes": [
    {
      "uri": "rdm/lookupTypes/Country",
      "settings": {
        "enabled": true,
        "mode": "ACTIVE",
        "autoMapEnabled": true,
        "autoMapThreshold": 0.70,
        "suggestionEnabled": true,
        "suggestionThreshold": 0.50,
        "createLookupEnabled": false,
        "createLookupThreshold": 0.90,
        "suggestLookupEnabled": false,
        "suggestLookupThreshold": 0.75,
        "misspelledThreshold": 0.70,
        "requiredFrequency": 5,
        "frequencyWindowHours": 1
      }
    }
  ]
}

Note:

Settings defined for a specific lookup type take precedence over tenant-level defaults. Use per-lookup-type settings to control behavior for a specific lookup type instead of changing global settings.
When createLookupEnabled is set to true, Autopilot automatically creates new lookup values when the confidence threshold is met. Use this carefully, as it adds entries to reference data.
When suggestLookupEnabled is set to true, Autopilot creates a Data Change Request (DCR) for review before adding a new lookup. Start with suggestions enabled for better control.

Unify and manage your data