> ## 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.
# Get an integration
> Get a specific integration by its ID.
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 get /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: 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: 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: 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}:
get:
tags:
- Integrations
summary: Get an integration
description: >
Get a specific integration by its ID.
This endpoint is in alpha, read more
[here](https://arize.com/docs/ax/rest-reference#api-version-stages).
operationId: integrations_get
parameters:
- $ref: '#/components/parameters/IntegrationIdPathParam'
responses:
'200':
$ref: '#/components/responses/Integration'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimitExceeded'
components:
parameters:
IntegrationIdPathParam:
name: integration_id
in: path
description: The unique integration identifier (base64 global ID).
required: true
schema:
$ref: '#/components/schemas/Id'
example: TGxtSW50ZWdyYXRpb246MTI6YUJjRA==
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: openAI
has_api_key: true
is_default_models_enabled: 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
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
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
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'
oneOf:
- $ref: '#/components/schemas/LlmIntegration'
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
LlmIntegration:
description: An LLM integration (type=llm).
allOf:
- $ref: '#/components/schemas/IntegrationBase'
- type: object
required:
- type
- config
properties:
type:
type: string
enum:
- llm
description: Discriminator identifying an LLM integration.
config:
$ref: '#/components/schemas/LlmConfig'
IntegrationBase:
type: object
description: Fields shared by every integration, regardless of `type`.
required:
- id
- type
- name
- scopings
- created_at
- updated_at
- created_by_user_id
properties:
id:
type: string
description: The integration ID (base64 global ID).
type:
$ref: '#/components/schemas/IntegrationType'
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: Global ID of the user who created the integration.
LlmConfig:
type: object
description: Per-provider LLM config, discriminated by `provider`.
discriminator:
propertyName: provider
mapping:
openAI:
$ref: '#/components/schemas/OpenAiConfig'
oneOf:
- $ref: '#/components/schemas/OpenAiConfig'
IntegrationType:
type: string
enum:
- llm
description: >-
The integration category. Selects the shape of `config`. Currently only
`llm` is implemented; additional types (agent, alerting, webhook) are
added non-breakingly.
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).
OpenAiConfig:
description: Config for an OpenAI LLM integration.
allOf:
- $ref: '#/components/schemas/LlmConfigBase'
- type: object
required:
- provider
- has_api_key
properties:
provider:
type: string
enum:
- openAI
description: Discriminator identifying the OpenAI provider.
has_api_key:
type: boolean
description: >-
Whether an API key is configured (the key itself is never
returned).
LlmConfigBase:
type: object
description: LLM config fields common across providers.
required:
- is_default_models_enabled
- is_function_calling_enabled
properties:
is_default_models_enabled:
type: boolean
description: Whether the provider's default model list is enabled.
is_function_calling_enabled:
type: boolean
description: Whether function/tool calling is enabled.
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
```
````