Skip to main content
PATCH

Authorizations

Authorization
string
header
required

Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format

Path Parameters

integration_id
string
required

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

Example:

"RW50aXR5OjEyMzQ1"

Body

application/json

Partially update an integration. The body is discriminated by type. Omitted fields are left unchanged.

Payload Requirements

  • type is required (it selects the per-type PATCH shape) and is immutable: it must match the stored integration's type, otherwise the request is rejected with 422 (change category by delete + recreate).
  • At least one updatable field (name, scopings, config, or — for AGENT and EVALUATORdescription) must be provided in addition to type. description is not a valid field for type: LLM and is rejected.
  • For LLM, config.provider is immutable, and config-field applicability is provider-specific (enforced with 422) — see the per-field docs on UpdateLlmConfig.
  • Envelope and config scalar fields deep-merge: omit = keep, explicit null = clear (for nullable fields).
  • Collections (scopings, config.model_names, config.headers, config.request_presets) replace the existing values when provided.
  • For type: EVALUATOR, config.headers accepts a string map (replace), null (clear), or may be omitted (keep).

Valid example

Invalid example (empty body)

Partial update of an integration, discriminated by type (immutable). The type field selects the per-type PATCH shape. Provide at least one updatable field in addition to type.

type
enum<string>
required

Discriminator. Immutable; must match the integration's type.

Available options:
LLM
name
string

New integration name.

scopings
object[]

Replaces the existing scoping rules.

config
object

Partial LLM config for PATCH. provider is immutable; if present it must match the stored value. Invalid provider/field combinations return 422.

Provider-specific fields:

  • api_key, is_function_calling_enabled: all except AWS_BEDROCK, VERTEX_AI
  • auth: AWS_BEDROCK only
  • base_url: ANTHROPIC, CUSTOM, LITELLM, NVIDIA_NIM
  • headers: CUSTOM, LITELLM, NVIDIA_NIM
  • is_default_models_enabled: AWS_BEDROCK, CUSTOM, FIREWORKS, NVIDIA_NIM
  • model_names: AWS_BEDROCK, CUSTOM, FIREWORKS, LITELLM, NVIDIA_NIM
  • project_id, location, project_access_label: VERTEX_AI only

Response

An integration object.

A polymorphic integration resource. The type field selects the config shape; for LLM, config.provider selects the per-provider config.

id
string
required

The unique identifier for the integration.

type
enum<string>
required

Discriminator identifying an LLM integration.

Available options:
LLM
name
string
required

The integration name. Unique per (account, type).

scopings
object[]
required

Visibility scoping rules. Account-wide when empty.

created_at
string<date-time>
required

When the integration was created.

updated_at
string<date-time>
required

When the integration was last updated.

created_by_user_id
string
required

Unique identifier of the user who created the integration.

config
object
required

Per-provider LLM config, discriminated by provider.