get_ai_configurations¶

ArtificialIntelligenceApi.get_ai_configurations(action, role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get AI configurations

Returns enablement status for every supported AI component, plus assigned models, default model and guard rails for enabled model-configurable components.

Parameters:

action (str) – Operation mode; only configurations is supported. (required)
role_id (str) – User role id (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

AIServiceConfigurationsBody

Returns:

Returns the result object.

Request and Response Examples¶

HTTP: GET /ai

Success (HTTP 200)¶

Successful API response

Request / response example

{
  "ServiceConfigurations": [
    {
      "ServiceName": "nl2sql",
      "Status": "Enabled",
      "AssignedModels": [
        "anthropic.claude-sonnet-4-6"
      ],
      "DefaultModel": "anthropic.claude-sonnet-4-6",
      "AssignedGuardRails": []
    },
    {
      "ServiceName": "knowledgebases",
      "Status": "Enabled",
      "AssignedModels": [
        "anthropic.claude-sonnet-4-6",
        "amazon.titan-embed-text-v2:0"
      ],
      "DefaultModel": "anthropic.claude-sonnet-4-6",
      "AssignedGuardRails": [
        {
          "Id": "gr-8f2e1a2b",
          "Version": "1",
          "Name": "pii-redaction"
        }
      ]
    },
    {
      "ServiceName": "catalog",
      "Status": "Disabled"
    }
  ]
}

Errors¶

Documented error codes: IPV-1001, AUTH-1002, GE-1008.

HTTP 400

Invalid input

action or resource missing or unrecognised

{
  "Message": "IPV-1001 - Invalid or missing action/resource; expected 'configurations' or 'repair' and 'knowledgebases'"
}

Role is not allowed to read AI configuration

{
  "Message": "AUTH-1002 - User action is not permitted"
}

HTTP 500

Something went wrong at backend. AI services being disabled for the application is also reported here.

Request / response example

{
  "Message": "GE-1008 - Could not complete the request. Please try again."
}