> ## Documentation Index
> Fetch the complete documentation index at: https://arize-ax.mintlify.site/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Update an integration
> Partially update an integration. `type` is immutable (and, for `LLM`,
`config.provider`). At least one field must be provided.
This endpoint is in alpha, read more [here](https://arize.com/docs/ax/rest-reference#api-version-stages).
## OpenAPI
````yaml https://api.arize.com/v2/spec.yaml patch /v2/integrations/{integration_id}
openapi: 3.0.3
info:
title: Arize REST API
version: 2.0.0
description: |
API specification for the backend data server. The API is hosted globally
at https://api.arize.com/v2 or in your own environment.
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- description: Global
url: https://api.arize.com
- description: Regional
url: https://api.{region}.arize.com
variables:
region:
default: eu-west-1a
enum:
- eu-west-1a
- ca-central-1a
- description: Custom Host
url: https://{host}
variables:
host:
default: api.arize.com
security:
- bearerAuth: []
tags:
- name: AI Integrations
description: |
AI integrations configure access to external LLM providers (e.g. OpenAI,
Azure OpenAI, AWS Bedrock, Vertex AI). Integrations can be scoped to the
entire account, a specific organization, or a specific space.
- name: Annotation Configs
description: >
Annotation configs allow you to define consistent annotation schemas that
can be reused across your workspace, ensuring evaluations are structured
and
comparable over time.
- name: Annotation Queues
description: >
Annotation queues help you organize and manage human evaluation workflows.
Use queues to assign spans or examples to annotators for review and
labeling.
- name: API Keys
description: >
API keys are used to authenticate requests to the Arize API. List your
keys
to view metadata; the raw secret is never returned after creation.
- name: Audit Logs
description: >
Audit logs record authenticated user actions within an account, providing
a
chronological trail for security and compliance review. Access requires
account admin privileges and audit logging to be enabled.
- name: Datasets
description: |
Datasets are structured, version-controlled example collections you use to
run, evaluate, and track LLM experiments.
- name: Evaluators
description: >
Evaluators are reusable evaluation configurations used to assess the
quality
of LLM outputs. They can be template-based (using LLM judges) or
code-based.
- name: Experiments
description: >
Experiments let you systematically test prompt/model changes using
datasets,
tasks, and evaluators.
- name: Integrations
description: >
Integrations configure access to external LLM providers (e.g. OpenAI,
Azure OpenAI, AWS Bedrock, Vertex AI), notifications services (e.g.
PagerDuty, Slack), and
your own agents. Integrations can be scoped to the entire account, a
specific
organization, or a specific space.
- name: Monitors
description: >
Monitors continuously track a metric over your model or LLM application
data
and alert you when it crosses a threshold. Each monitor watches a single
metric - data quality, model performance, drift, a custom metric, or a
tracing metric - and moves between statuses as the metric passes in and
out of its
healthy range.
- name: Organizations
description: >
Organizations are top-level containers within an Arize AX account for
grouping spaces.
- name: Projects
description: |
Projects represent LLM applications being monitored in Arize where you can
observe traces and spans.
- name: Prompts
description: >
Prompts are reusable, versioned templates for LLM interactions. Use
prompts
to standardize and manage how you interact with LLMs across your
application.
- name: Resource Restrictions
description: |
Endpoints for restricting and unrestricting resources (projects, models).
- name: Role Bindings
description: |
Role bindings assign a role to a user on a resource. REST currently
supports space- and project-scoped bindings.
- name: Roles
description: >
Roles define sets of permissions that can be assigned to users within an
account. Create custom roles to tailor access control to your team's
needs.
- name: Spaces
description: >
Spaces are containers within an organization for grouping related
projects,
datasets, and experiments, enabling collaboration or isolated
experimentation
with role-based access control.
- name: Spans
description: |
Spans represent individual operations within a trace. A span captures the
timing, status, and attributes of a single operation in your application.
- name: Tasks
description: |
Tasks are configurable units of work that tie one or more evaluators to a
data source (project or dataset). Use tasks to automate evaluation of LLM
outputs, with support for continuous evaluation and backfill runs.
- name: Traces
description: |
A trace is the collection of spans sharing a trace ID, representing a
single end-to-end request through an LLM application. Use the Traces
endpoint to retrieve traces with all of their spans in one call.
- name: Users
description: >
Users represent members of an account. The Users endpoints allow creating,
listing, updating (display name), and removing users from the account
programmatically.
paths:
/v2/integrations/{integration_id}:
patch:
tags:
- Integrations
summary: Update an integration
description: >
Partially update an integration. `type` is immutable (and, for `LLM`,
`config.provider`). At least one field must be provided.
This endpoint is in alpha, read more
[here](https://arize.com/docs/ax/rest-reference#api-version-stages).
operationId: update_integration
parameters:
- $ref: '#/components/parameters/IntegrationIdPathParam'
requestBody:
$ref: '#/components/requestBodies/UpdateIntegrationRequestBody'
responses:
'200':
$ref: '#/components/responses/Integration'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'429':
$ref: '#/components/responses/RateLimitExceeded'
components:
parameters:
IntegrationIdPathParam:
name: integration_id
in: path
description: The unique integration identifier.
required: true
schema:
$ref: '#/components/schemas/Id'
example: TGxtSW50ZWdyYXRpb246MTI6YUJjRA==
requestBodies:
UpdateIntegrationRequestBody:
description: |
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` only — `description`) 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.
**Valid example**
```json
{
"type": "LLM",
"name": "Updated OpenAI",
"config": { "is_function_calling_enabled": true }
}
```
**Invalid example** (empty body)
```json
{}
```
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateIntegrationRequest'
responses:
Integration:
description: An integration object.
content:
application/json:
schema:
$ref: '#/components/schemas/Integration'
example:
id: TGxtSW50ZWdyYXRpb246MTI6YUJjRA==
type: LLM
name: Production OpenAI
scopings:
- organization_id: null
space_id: null
created_at: '2026-02-13T21:27:19.055Z'
updated_at: '2026-02-13T21:27:19.279Z'
created_by_user_id: VXNlcjoxOm5OYkM=
config:
provider: OPEN_AI
has_api_key: true
is_function_calling_enabled: true
BadRequest:
description: Invalid request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 400
title: Invalid request parameters
detail: The 'name' field is required and must be a non-empty string.
instance: /resource
type: https://arize.com/docs/ax/rest-reference/errors#invalid-request
Unauthorized:
description: Authentication is required
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 401
title: Authentication required
detail: You must be authenticated to access this resource.
instance: /resource
type: >-
https://arize.com/docs/ax/rest-reference/errors#authentication-required
Forbidden:
description: Insufficient permissions to access this resource
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 403
title: Access forbidden
detail: You do not have permission to access this resource.
instance: /resource/12345
type: https://arize.com/docs/ax/rest-reference/errors#access-forbidden
NotFound:
description: Not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 404
title: Resource not found
detail: The requested resource with ID '12345' was not found.
instance: /resource/12345
type: https://arize.com/docs/ax/rest-reference/errors#resource-not-found
Conflict:
description: Resource conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 409
title: Resource conflict
detail: A resource with the given identifier already exists.
instance: /resource
type: https://arize.com/docs/ax/rest-reference/errors#resource-conflict
UnprocessableEntity:
description: Unprocessable entity
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 422
title: Unprocessable Entity
detail: One or more fields failed validation.
instance: /resource/12345
type: >-
https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity
RateLimitExceeded:
description: Rate limit exceeded
headers:
Retry-After:
description: |
When throttled (429), how long to wait before retrying. Value is
either a delta-seconds integer.
schema:
type: integer
minimum: 0
example: 42
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 429
title: Rate limit exceeded
detail: >-
You have exceeded the allowed number of requests. Please try again
later.
instance: /resource
type: >-
https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded
schemas:
Id:
type: string
description: A universally unique identifier (base64-encoded opaque string).
example: RW50aXR5OjEyMzQ1
UpdateIntegrationRequest:
type: object
description: >-
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:
propertyName: type
mapping:
LLM:
$ref: '#/components/schemas/UpdateLlmIntegrationRequest'
AGENT:
$ref: '#/components/schemas/UpdateAgentIntegrationRequest'
oneOf:
- $ref: '#/components/schemas/UpdateLlmIntegrationRequest'
- $ref: '#/components/schemas/UpdateAgentIntegrationRequest'
Integration:
type: object
description: >-
A polymorphic integration resource. The `type` field selects the
`config` shape; for `LLM`, `config.provider` selects the per-provider
config.
discriminator:
propertyName: type
mapping:
LLM:
$ref: '#/components/schemas/LlmIntegration'
AGENT:
$ref: '#/components/schemas/AgentIntegration'
oneOf:
- $ref: '#/components/schemas/LlmIntegration'
- $ref: '#/components/schemas/AgentIntegration'
Problem:
type: object
description: RFC 9457 Problem Details
properties:
title:
type: string
description: A short, human-readable summary of the problem type
status:
type: integer
description: >-
The HTTP status code generated by the origin server for this
occurrence of the problem
type:
type: string
format: uri-reference
description: A URI reference that identifies the problem type
detail:
type: string
description: >-
A human-readable explanation specific to this occurrence of the
problem
instance:
type: string
format: uri-reference
description: >-
A URI reference that identifies the specific occurrence of the
problem
required:
- title
- status
additionalProperties: false
UpdateLlmIntegrationRequest:
type: object
description: >-
PATCH body for an `LLM` integration. `type` is required (it selects the
union member) and immutable. Provide at least one updatable field
(`name`, `scopings`, or `config`) in addition to `type`. `scopings`
replaces on provide.
required:
- type
properties:
type:
type: string
enum:
- LLM
description: Discriminator. Immutable; must match the integration's type.
name:
type: string
description: New integration name.
scopings:
type: array
items:
$ref: '#/components/schemas/IntegrationScoping'
description: Replaces the existing scoping rules.
config:
$ref: '#/components/schemas/UpdateLlmConfig'
additionalProperties: false
UpdateAgentIntegrationRequest:
type: object
description: |
Partial update body for `type=AGENT`. `type` is immutable; if present
it must equal `AGENT` (422 otherwise).
required:
- type
properties:
type:
type: string
enum:
- AGENT
description: Discriminator. Immutable; must match the integration's type.
name:
type: string
description:
type: string
nullable: true
scopings:
type: array
items:
$ref: '#/components/schemas/IntegrationScoping'
description: Replace-on-provide. Empty array reverts to account-wide.
config:
$ref: '#/components/schemas/UpdateAgentConfig'
additionalProperties: false
LlmIntegration:
description: An LLM integration (type=LLM).
type: object
required:
- id
- type
- name
- scopings
- created_at
- updated_at
- created_by_user_id
- config
properties:
id:
type: string
description: The unique identifier for the integration.
type:
type: string
enum:
- LLM
description: Discriminator identifying an LLM integration.
name:
type: string
description: The integration name. Unique per (account, type).
scopings:
type: array
items:
$ref: '#/components/schemas/IntegrationScoping'
description: Visibility scoping rules. Account-wide when empty.
created_at:
type: string
format: date-time
description: When the integration was created.
updated_at:
type: string
format: date-time
description: When the integration was last updated.
created_by_user_id:
type: string
description: Unique identifier of the user who created the integration.
config:
$ref: '#/components/schemas/LlmConfig'
AgentIntegration:
description: |
An agent integration (type=AGENT): a customer-hosted HTTPS endpoint plus
a JSON Schema describing the request payload.
type: object
required:
- id
- type
- name
- scopings
- created_at
- updated_at
- created_by_user_id
- config
properties:
id:
type: string
description: The unique identifier for the integration.
type:
type: string
enum:
- AGENT
description: Discriminator identifying an agent integration.
name:
type: string
description: The integration name. Unique per (account, type).
description:
type: string
nullable: true
description: Optional human-readable description of the integration.
scopings:
type: array
items:
$ref: '#/components/schemas/IntegrationScoping'
description: Visibility scoping rules. Account-wide when empty.
created_at:
type: string
format: date-time
description: When the integration was created.
updated_at:
type: string
format: date-time
description: When the integration was last updated.
created_by_user_id:
type: string
nullable: true
description: >-
Unique identifier of the user who created the integration. Null if
that user has since been deleted.
config:
$ref: '#/components/schemas/AgentConfig'
IntegrationScoping:
type: object
description: Visibility scoping for the integration.
properties:
organization_id:
type: string
nullable: true
description: Organization identifier (base64). Null means account-wide.
space_id:
type: string
nullable: true
description: >-
Space identifier (base64). Null means organization-wide (or
account-wide when organization_id is also null).
UpdateLlmConfig:
type: object
description: >-
Partial LLM config for PATCH. `provider` is immutable; if present it
must match the stored value. Field applicability is provider-specific
and enforced by the handler with 422: `api_key` and
`is_function_calling_enabled` do not apply to `AWS_BEDROCK` or
`VERTEX_AI`; `auth` applies to `AWS_BEDROCK` only; `base_url` and
`headers` apply to `CUSTOM` and `NVIDIA_NIM` only;
`is_default_models_enabled` and `model_names` apply to `AWS_BEDROCK`,
`CUSTOM`, and `NVIDIA_NIM` only; `project_id`, `location`, and
`project_access_label` apply to `VERTEX_AI` only.
properties:
provider:
$ref: '#/components/schemas/LlmIntegrationProvider'
api_key:
type: string
nullable: true
description: >-
Rotate the API key. Pass null to clear it. Omit to keep unchanged.
Not valid for `AWS_BEDROCK` (bearer tokens are rotated via `auth`).
is_function_calling_enabled:
type: boolean
description: >-
Enable or disable function/tool calling. Omit to keep unchanged. Not
valid for `AWS_BEDROCK`.
auth:
$ref: '#/components/schemas/CreateAwsBedrockAuth'
base_url:
type: string
nullable: true
description: >-
(`CUSTOM` and `NVIDIA_NIM` only) New endpoint URL. For `NVIDIA_NIM`
the field is optional on the resource, so null clears it (falling
back to the provider default endpoint). For `CUSTOM` it is required
on the resource — null is rejected with 422. Omit to keep unchanged.
headers:
type: object
nullable: true
additionalProperties:
type: string
description: >-
(`CUSTOM` and `NVIDIA_NIM` only) Replaces the configured custom
request headers: the provided map becomes the full header set. Pass
null to clear all headers. Omit to keep unchanged. Write-only; names
are exposed as `header_names` on read. The serialized header map
must not exceed 8,175 bytes.
is_default_models_enabled:
type: boolean
description: >-
(`AWS_BEDROCK`, `CUSTOM`, and `NVIDIA_NIM` only) Enable or disable
Arize's default model catalog. The effective config must keep at
least one model source or the request is rejected with 422. Omit to
keep unchanged.
model_names:
type: array
items:
type: string
description: >-
(`AWS_BEDROCK`, `CUSTOM`, and `NVIDIA_NIM` only) Replaces the custom
model list. The effective config must keep at least one model source
or the request is rejected with 422. Omit to keep unchanged.
project_id:
type: string
description: >-
(`VERTEX_AI` only) New GCP project ID. Required on the resource, so
it may be changed but never cleared; omitted fields keep their
stored values (per-scalar deep-merge).
location:
type: string
description: >-
(`VERTEX_AI` only) New GCP region. Required on the resource, so it
may be changed but never cleared; omitted fields keep their stored
values (per-scalar deep-merge).
project_access_label:
type: string
description: >-
(`VERTEX_AI` only) New project-access label. Required on the
resource, so it may be changed but never cleared; omitted fields
keep their stored values (per-scalar deep-merge).
additionalProperties: false
UpdateAgentConfig:
type: object
description: |
Partial agent config for PATCH. All collection fields are
replace-on-provide.
properties:
endpoint:
type: string
format: uri
maxLength: 2048
headers:
type: object
nullable: true
additionalProperties:
type: string
description: |
Replace-on-provide. Pass `null` (or `{}`) to clear all headers.
Encrypted at rest; never returned in responses.
input_schema:
type: object
additionalProperties: true
description: New JSON Schema for the request payload shape.
request_presets:
type: array
items:
$ref: '#/components/schemas/UpdateAgentRequestPresetInput'
description: |
Replace-on-provide preset list, matched by `name`: existing names
update in place (preserving id/timestamps), new names insert,
removed names delete.
additionalProperties: false
LlmConfig:
type: object
description: Per-provider LLM config, discriminated by `provider`.
discriminator:
propertyName: provider
mapping:
OPEN_AI:
$ref: '#/components/schemas/OpenAiConfig'
ANTHROPIC:
$ref: '#/components/schemas/AnthropicConfig'
GEMINI:
$ref: '#/components/schemas/GeminiConfig'
AWS_BEDROCK:
$ref: '#/components/schemas/AwsBedrockConfig'
CUSTOM:
$ref: '#/components/schemas/CustomConfig'
VERTEX_AI:
$ref: '#/components/schemas/VertexAiConfig'
NVIDIA_NIM:
$ref: '#/components/schemas/NvidiaNimConfig'
oneOf:
- $ref: '#/components/schemas/OpenAiConfig'
- $ref: '#/components/schemas/AnthropicConfig'
- $ref: '#/components/schemas/GeminiConfig'
- $ref: '#/components/schemas/AwsBedrockConfig'
- $ref: '#/components/schemas/CustomConfig'
- $ref: '#/components/schemas/VertexAiConfig'
- $ref: '#/components/schemas/NvidiaNimConfig'
AgentConfig:
type: object
description: |
Configuration for `type: AGENT` integrations: a customer-hosted HTTPS
endpoint plus a JSON Schema describing the request payload.
required:
- endpoint
- has_headers
- input_schema
- request_presets
properties:
endpoint:
type: string
format: uri
maxLength: 2048
description: |
HTTPS endpoint URL Arize calls for replay. Validated server-side
for SSRF (must resolve to a public address).
has_headers:
type: boolean
readOnly: true
description: |
Whether any headers are configured. Read-only — derived from
`headers` on write. Header values are never returned.
input_schema:
type: object
additionalProperties: true
description: |
JSON Schema (Draft-07) the endpoint's request body conforms to.
request_presets:
type: array
items:
$ref: '#/components/schemas/AgentRequestPreset'
description: |
Named, reusable request payloads. Replace-on-provide on PATCH.
Always present; an integration with no presets returns `[]`.
additionalProperties: false
LlmIntegrationProvider:
type: string
enum:
- OPEN_AI
- ANTHROPIC
- GEMINI
- AWS_BEDROCK
- CUSTOM
- VERTEX_AI
- NVIDIA_NIM
description: >-
The LLM vendor for an `LLM` integration. Selects the per-provider
`config` member. `OPEN_AI`, `ANTHROPIC`, `GEMINI`, `AWS_BEDROCK`,
`CUSTOM`, `VERTEX_AI`, and `NVIDIA_NIM` are implemented; additional
providers are added non-breakingly.
CreateAwsBedrockAuth:
type: object
description: >-
AWS Bedrock auth settings for create and update, discriminated by
`auth_type`. On PATCH this object replaces the stored auth settings
wholesale (auth_type may change); omitted fields of the previous auth
mode are cleared.
discriminator:
propertyName: auth_type
mapping:
DEFAULT:
$ref: '#/components/schemas/CreateAwsBedrockDefaultAuth'
BEARER_TOKEN:
$ref: '#/components/schemas/CreateAwsBedrockBearerTokenAuth'
PROXY_WITH_HEADERS:
$ref: '#/components/schemas/CreateAwsBedrockProxyWithHeadersAuth'
oneOf:
- $ref: '#/components/schemas/CreateAwsBedrockDefaultAuth'
- $ref: '#/components/schemas/CreateAwsBedrockBearerTokenAuth'
- $ref: '#/components/schemas/CreateAwsBedrockProxyWithHeadersAuth'
UpdateAgentRequestPresetInput:
type: object
description: >
Write shape for an agent request preset on update. Matched by `name`:
existing names update in place (preserving id/timestamps), new names
insert,
removed names delete. Server-generated fields (`id`, `created_at`,
`updated_at`) are not accepted on input.
required:
- name
- config
properties:
name:
type: string
minLength: 1
maxLength: 255
description: Preset name (unique within the integration). Length 1-255.
description:
type: string
maxLength: 1024
nullable: true
description: Optional preset description (length 0-1024).
config:
type: object
additionalProperties: true
description: |
Partial request body. Validated against the parent integration's
`input_schema` with `required` dropped.
additionalProperties: false
OpenAiConfig:
description: Config for an OpenAI LLM integration.
type: object
required:
- is_function_calling_enabled
- provider
- has_api_key
properties:
is_function_calling_enabled:
type: boolean
description: Whether function/tool calling is enabled.
provider:
type: string
enum:
- OPEN_AI
description: Discriminator identifying the OpenAI provider.
has_api_key:
type: boolean
description: Whether an API key is configured (the key itself is never returned).
AnthropicConfig:
description: Config for an Anthropic LLM integration.
type: object
required:
- is_function_calling_enabled
- provider
- has_api_key
properties:
is_function_calling_enabled:
type: boolean
description: Whether function/tool calling is enabled.
provider:
type: string
enum:
- ANTHROPIC
description: Discriminator identifying the Anthropic provider.
has_api_key:
type: boolean
description: Whether an API key is configured (the key itself is never returned).
GeminiConfig:
description: Config for a Google Gemini LLM integration.
type: object
required:
- is_function_calling_enabled
- provider
- has_api_key
properties:
is_function_calling_enabled:
type: boolean
description: Whether function/tool calling is enabled.
provider:
type: string
enum:
- GEMINI
description: Discriminator identifying the Gemini provider.
has_api_key:
type: boolean
description: Whether an API key is configured (the key itself is never returned).
AwsBedrockConfig:
type: object
description: >-
Config for an AWS Bedrock LLM integration. The model catalog is
caller-controlled via `is_default_models_enabled` and `model_names`.
Function/tool-calling settings do not apply to Bedrock and are omitted.
required:
- provider
- is_default_models_enabled
- model_names
- auth
properties:
provider:
type: string
enum:
- AWS_BEDROCK
description: Discriminator identifying the AWS Bedrock provider.
is_default_models_enabled:
type: boolean
description: Whether Arize's default Bedrock model catalog is enabled.
model_names:
type: array
items:
type: string
description: Custom model names configured on this integration. Empty when none.
auth:
$ref: '#/components/schemas/AwsBedrockAuth'
CustomConfig:
description: >-
Config for a custom OpenAI-compatible endpoint integration. `base_url`
is the endpoint Arize sends requests to; it must implement the OpenAI
API shape. Secrets are write-only: the API key surfaces as `has_api_key`
and custom request headers surface as `header_names` (names only).
type: object
required:
- is_function_calling_enabled
- provider
- has_api_key
- base_url
- header_names
- is_default_models_enabled
- model_names
properties:
is_function_calling_enabled:
type: boolean
description: Whether function/tool calling is enabled.
provider:
type: string
enum:
- CUSTOM
description: Discriminator identifying a custom OpenAI-compatible endpoint.
has_api_key:
type: boolean
description: Whether an API key is configured (the key itself is never returned).
base_url:
type: string
description: Endpoint URL requests are sent to.
header_names:
type: array
items:
type: string
description: >-
Names of the custom request headers configured on this integration.
Empty when none are configured. Header values are write-only and
never returned.
is_default_models_enabled:
type: boolean
description: Whether Arize's default model catalog is enabled.
model_names:
type: array
items:
type: string
description: Custom model names configured on this integration. Empty when none.
VertexAiConfig:
type: object
description: >-
Config for a Google Vertex AI integration. Vertex stores no credentials:
Arize accesses Vertex through the configured GCP project. All fields are
returned on read.
required:
- provider
- project_id
- location
- project_access_label
properties:
provider:
type: string
enum:
- VERTEX_AI
description: Discriminator identifying the Vertex AI provider.
project_id:
type: string
description: GCP project ID Arize accesses Vertex through.
location:
type: string
description: GCP region (e.g. us-central1).
project_access_label:
type: string
description: Label used to verify Arize's access to the GCP project.
NvidiaNimConfig:
description: >-
Config for an NVIDIA NIM integration. Every connection field is
optional: `base_url` targets a self-hosted NIM endpoint (null when using
the provider default). Secrets are write-only: the API key surfaces as
`has_api_key` and custom request headers surface as `header_names`
(names only).
type: object
required:
- is_function_calling_enabled
- provider
- has_api_key
- base_url
- header_names
- is_default_models_enabled
- model_names
properties:
is_function_calling_enabled:
type: boolean
description: Whether function/tool calling is enabled.
provider:
type: string
enum:
- NVIDIA_NIM
description: Discriminator identifying the NVIDIA NIM provider.
has_api_key:
type: boolean
description: Whether an API key is configured (the key itself is never returned).
base_url:
type: string
nullable: true
description: Self-hosted NIM endpoint URL. Null when not set.
header_names:
type: array
items:
type: string
description: >-
Names of the custom request headers configured on this integration.
Empty when none are configured. Header values are write-only and
never returned.
is_default_models_enabled:
type: boolean
description: Whether Arize's default model catalog is enabled.
model_names:
type: array
items:
type: string
description: Custom model names configured on this integration. Empty when none.
AgentRequestPreset:
type: object
description: >
A named, reusable request payload bound to an agent integration.
Embedded
in `agent.config.request_presets[]`. There is no standalone preset
endpoint; presets are managed exclusively via the nested collection on
the parent integration.
Validation rules:
- `name` is unique within the integration (case-sensitive). Length
1-255.
- `description` length 0-1024 (nullable).
- `config` must conform to the integration's `input_schema` *with
`required` dropped* (present fields validated; missing fields ignored).
required:
- name
- config
properties:
id:
type: string
readOnly: true
description: Server-generated, opaque preset identifier. Read-only.
name:
type: string
minLength: 1
maxLength: 255
description: Preset name (unique within the integration). Length 1-255.
description:
type: string
maxLength: 1024
nullable: true
description: Optional preset description (length 0-1024).
config:
type: object
additionalProperties: true
description: |
Partial request body. Validated against the parent integration's
`input_schema` with `required` dropped.
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
additionalProperties: false
CreateAwsBedrockDefaultAuth:
type: object
description: Create role-assumption auth. `role_arn` is required.
required:
- auth_type
- role_arn
properties:
auth_type:
type: string
enum:
- DEFAULT
role_arn:
type: string
description: AWS IAM role ARN Arize assumes for cross-account access.
external_id:
type: string
description: External ID on the assume-role policy. Defaults to not set.
base_url:
type: string
description: >-
Custom Bedrock endpoint URL. Defaults to the provider default
endpoint.
additionalProperties: false
CreateAwsBedrockBearerTokenAuth:
type: object
description: >-
Create bearer-token auth. `api_key` is required and write-only (never
returned; surfaces as `has_api_key` on read).
required:
- auth_type
- api_key
properties:
auth_type:
type: string
enum:
- BEARER_TOKEN
api_key:
type: string
description: Bearer token for Bedrock (write-only, never returned).
base_url:
type: string
description: >-
Custom Bedrock endpoint URL. Defaults to the provider default
endpoint.
additionalProperties: false
CreateAwsBedrockProxyWithHeadersAuth:
type: object
description: >-
Create proxy auth. `base_url` is required. `headers` is write-only;
names are returned as `header_names` on read.
required:
- auth_type
- base_url
properties:
auth_type:
type: string
enum:
- PROXY_WITH_HEADERS
base_url:
type: string
description: Proxy URL requests are forwarded to (HTTPS).
headers:
type: object
additionalProperties:
type: string
description: >-
Custom request headers sent to the proxy, as a name-to-value map.
Write-only: values are never returned; names are exposed as
`header_names` on read. Defaults to no headers. The serialized
header map must not exceed 8,175 bytes.
additionalProperties: false
AwsBedrockAuth:
type: object
description: AWS Bedrock auth settings, discriminated by `auth_type`.
discriminator:
propertyName: auth_type
mapping:
DEFAULT:
$ref: '#/components/schemas/AwsBedrockDefaultAuth'
BEARER_TOKEN:
$ref: '#/components/schemas/AwsBedrockBearerTokenAuth'
PROXY_WITH_HEADERS:
$ref: '#/components/schemas/AwsBedrockProxyWithHeadersAuth'
oneOf:
- $ref: '#/components/schemas/AwsBedrockDefaultAuth'
- $ref: '#/components/schemas/AwsBedrockBearerTokenAuth'
- $ref: '#/components/schemas/AwsBedrockProxyWithHeadersAuth'
AwsBedrockDefaultAuth:
type: object
description: >-
Role-assumption auth for AWS Bedrock: Arize assumes the provided IAM
role to call Bedrock. The role ARN and external ID are not secrets and
are returned on read.
required:
- auth_type
- role_arn
- external_id
- base_url
properties:
auth_type:
type: string
enum:
- DEFAULT
description: Discriminator identifying role-assumption auth.
role_arn:
type: string
description: AWS IAM role ARN Arize assumes for cross-account access.
external_id:
type: string
nullable: true
description: External ID on the assume-role policy. Null when not set.
base_url:
type: string
nullable: true
description: Custom Bedrock endpoint URL. Null when not set.
additionalProperties: false
AwsBedrockBearerTokenAuth:
type: object
description: >-
Bearer-token auth for AWS Bedrock. The token surfaces as `has_api_key`
on read; the token itself is never returned.
required:
- auth_type
- has_api_key
- base_url
properties:
auth_type:
type: string
enum:
- BEARER_TOKEN
description: Discriminator identifying bearer-token auth.
has_api_key:
type: boolean
description: >-
Whether a bearer token is configured (the token itself is never
returned). Always true for integrations created through this API;
may be false for integrations created through the Arize UI without a
token.
base_url:
type: string
nullable: true
description: Custom Bedrock endpoint URL. Null when not set.
additionalProperties: false
AwsBedrockProxyWithHeadersAuth:
type: object
description: >-
Proxy auth for AWS Bedrock: requests are forwarded to a proxy URL with
custom headers. Header values are write-only; configured names are
returned as `header_names`.
required:
- auth_type
- base_url
- header_names
properties:
auth_type:
type: string
enum:
- PROXY_WITH_HEADERS
description: Discriminator identifying proxy auth.
base_url:
type: string
description: Proxy URL requests are forwarded to.
header_names:
type: array
items:
type: string
description: >-
Names of the custom request headers configured on this integration.
Empty when none are configured. Header values are write-only and
never returned.
additionalProperties: false
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat:
description: >
Most Arize AI endpoints require authentication. For those endpoints that
require authentication, include your API key in the request header using
the format
``` Authorization: Bearer
```
````