Sign in

v2

latestOpenAPI 3.0.3Apache-2.02026-08-07119359591.9 KB
AI Integrations

Update an AI integration

Update an AI integration's configuration. At least one field must be provided. Omitted fields are left unchanged.

Payload Requirements

  • At least one of the updatable fields must be provided.
  • name, if provided, must be unique within the account.
  • api_key can be set to null to remove the existing key, or omitted to keep it unchanged.
  • scopings, if provided, replaces all existing scoping rules.
  • provider_metadata, if provided, replaces existing metadata. Set to null to remove.

Valid example

{
  "name": "Updated Integration",
  "model_names": ["gpt-4o", "gpt-4o-mini"]
}

Invalid example (empty body)

{}

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

patch/v2/ai-integrations/{integration_id}

Path parameters

integration_idstring required

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

Example:RW50aXR5OjEyMzQ1

The unique AI integration identifier (base64)

Request body

namestring

New integration name

provider'OPEN_AI' | 'AZURE_OPEN_AI' | 'AWS_BEDROCK' | 'VERTEX_AI' | 'ANTHROPIC' | 'CUSTOM' | 'NVIDIA_NIM' | 'GEMINI'

The AI provider for this integration

api_keystring nullable

New API key. Pass null to remove the existing key. Omit to keep unchanged.

base_urlstring nullable

Custom base URL. Pass null to remove.

model_namesstring[]

Supported model names (replaces all)

headersobject nullable

Custom headers. Pass null to remove. The serialized header map must not exceed 8,175 bytes.

enable_default_modelsboolean

Enable provider's default model list

function_calling_enabledboolean

Enable function/tool calling

auth_type'DEFAULT' | 'PROXY_WITH_HEADERS' | 'BEARER_TOKEN'

The authentication method for this integration

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' 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' required

The authentication method for this integration

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