Update an integration
Partially update an integration. type is immutable (and, for LLM,
config.provider). At least one field must be provided.
Payload Requirements
typeis 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,description,scopings,config) must be provided in addition totype. - Scalar fields deep-merge: omit = keep, explicit
null= clear (for nullable fields). - Collection fields (
scopings,config.headers) replace the existing values when provided. - For
type: EVALUATOR,config.headersaccepts a string map (replace),null(clear), or may be omitted (keep). type: EVALUATORrequires the remote evaluators feature to be enabled.
Valid example (type: EVALUATOR)
{
"type": "EVALUATOR",
"config": {
"endpoint": "https://eval.example.com/v2/evaluate"
}
}
Invalid example (type mismatch)
{
"type": "AGENT"
}
Authorizations
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
The unique integration identifier. A universally unique identifier (base64-encoded opaque string).
"RW50aXR5OjEyMzQ1"
Body
Partially update an integration. The body is discriminated by type.
Omitted fields are left unchanged.
Payload Requirements
typeis 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 — forAGENTandEVALUATOR—description) must be provided in addition totype.descriptionis not a valid field fortype: LLMand is rejected. - For
LLM,config.provideris immutable, and config-field applicability is provider-specific (enforced with 422) — see the per-field docs onUpdateLlmConfig. - Envelope and
configscalar fields deep-merge: omit = keep, explicitnull= clear (for nullable fields). - Collections (
scopings,config.model_names,config.headers,config.request_presets) replace the existing values when provided. - For
type: EVALUATOR,config.headersaccepts a string map (replace),null(clear), or may be omitted (keep).
Valid example
{ "type": "LLM", "name": "Updated OpenAI", "config": { "is_function_calling_enabled": true } }
Invalid example (empty body)
{}
- Option 1
- Option 2
- Option 3
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.
Discriminator. Immutable; must match the integration's type.
LLM New integration name.
Replaces the existing scoping rules.
Show child attributes
Show child attributes
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 exceptAWS_BEDROCK,VERTEX_AIauth:AWS_BEDROCKonlybase_url:ANTHROPIC,CUSTOM,LITELLM,NVIDIA_NIMheaders:CUSTOM,LITELLM,NVIDIA_NIMis_default_models_enabled:AWS_BEDROCK,CUSTOM,FIREWORKS,NVIDIA_NIMmodel_names:AWS_BEDROCK,CUSTOM,FIREWORKS,LITELLM,NVIDIA_NIMproject_id,location,project_access_label:VERTEX_AIonly
Show child attributes
Show child attributes
Response
An integration object.
- Option 1
- Option 2
- Option 3
A polymorphic integration resource. The type field selects the config shape; for LLM, config.provider selects the per-provider config.
The unique identifier for the integration.
Discriminator identifying an LLM integration.
LLM The integration name. Unique per (account, type).
Visibility scoping rules. Account-wide when empty.
Show child attributes
Show child attributes
When the integration was created.
When the integration was last updated.
Unique identifier of the user who created the integration.
Per-provider LLM config, discriminated by provider.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
Show child attributes
Show child attributes
Was this page helpful?