AI Integrations

Get an AI integration

Changed on

Get a specific AI integration by its ID.

<Warning>This endpoint is in alpha, read more here.</Warning>

get/v2/ai-integrations/{integration_id}

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/ai-integrations/{integration_id}
  • Auth
    HTTP bearer

Path parameters

integration_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique AI integration identifier (base64)

Response

An AI integration object

idstring required

The integration ID

namestring required

The integration name

provider'OPEN_AI' | 'AZURE_OPEN_AI' | 'AWS_BEDROCK' | 'VERTEX_AI' | 'ANTHROPIC' | 'CUSTOM' | 'NVIDIA_NIM' | 'GEMINI' | 'LITELLM' | 'FIREWORKS' | 'TOGETHER_AI' required

The AI provider for this integration

has_api_keyboolean required

Whether an API key is configured (the key itself is never returned)

base_urlstring nullable

Custom base URL for the provider

model_namesstring[] nullable

Supported model names

headersobject nullable

Custom headers included in requests

enable_default_modelsboolean required

Whether the provider's default model list is enabled

function_calling_enabledboolean required

Whether function/tool calling is enabled

auth_type'DEFAULT' | 'PROXY_WITH_HEADERS' | 'BEARER_TOKEN' | 'OAUTH2_CLIENT_CREDENTIALS' required

The authentication method for this integration. OAUTH2_CLIENT_CREDENTIALS is returned for integrations configured with OAuth 2.0 client credentials in the Arize UI. Setting it through this API is not yet supported.

created_atstring date-time required

When the integration was created

updated_atstring date-time required

When the integration was last updated

created_by_user_idstring required

The user ID of the user who created the integration

Changes

  • 00294ff0845aRevision changes
    • warning

      added the new TOGETHER_AI enum value to the response property for the response status

  • 15b98c7ec8ccRevision changes
    • warning

      added the new FIREWORKS enum value to the response property for the response status