Create a new AI integration for an external LLM provider.
Payload Requirements
name and provider are required.provider must be one of: openAI, azureOpenAI, awsBedrock, vertexAI, anthropic, custom.scopings is omitted, the integration defaults to account-wide visibility.enable_default_models defaults to false if not provided.function_calling_enabled defaults to true if not provided.auth_type defaults to default if not provided.awsBedrock provider, provider_metadata must include role_arn.vertexAI provider, provider_metadata must include project_id, location, and project_access_label.Valid example
{
"name": "Production OpenAI",
"provider": "openAI",
"api_key": "sk-abc123...",
"model_names": ["gpt-4", "gpt-4o"],
"enable_default_models": true
}
Invalid example (missing required provider)
{
"name": "My Integration"
}
Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format
Body containing AI integration creation parameters
Integration name
The AI provider for this integration
openAI, azureOpenAI, awsBedrock, vertexAI, anthropic, custom, nvidiaNim, gemini API key for the provider (write-only, never returned)
Custom base URL for the provider
Supported model names
Custom headers to include in requests
Enable provider's default model list (default false)
Enable function/tool calling (default true)
The authentication method for this integration
default, proxy_with_headers, bearer_token Provider-specific configuration (AWS or GCP metadata)
Visibility scoping rules. Defaults to account-wide.
An AI integration object
An AI integration configures access to an external LLM provider (e.g. OpenAI, Azure OpenAI, AWS Bedrock, Vertex AI). Integrations can be scoped to the entire account, a specific organization, or a specific space.
The integration ID
The integration name
The AI provider for this integration
openAI, azureOpenAI, awsBedrock, vertexAI, anthropic, custom, nvidiaNim, gemini Whether an API key is configured (the key itself is never returned)
Whether the provider's default model list is enabled
Whether function/tool calling is enabled
The authentication method for this integration
default, proxy_with_headers, bearer_token Visibility scoping rules
When the integration was created
When the integration was last updated
The user ID of the user who created the integration
Custom base URL for the provider
Supported model names
Custom headers included in requests
Provider-specific configuration (AWS or GCP metadata)