Skip to main content
POST
Create an integration

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

Body

application/json

Create a new integration. The type field selects the config shape; for LLM, config.provider selects the per-provider config.

Payload Requirements

  • type, name, and config are required.
  • name must be unique within the account for the given type.
  • scopings defaults to account-wide visibility when omitted.
  • Type- and provider-specific rules (required fields, defaults, write-only secrets) are documented on each config schema: see the per-provider members of CreateLlmConfig for type: LLM, and CreateAgentConfig for type: AGENT.

Valid example

Invalid example (missing required config)

Invalid example (missing required config.provider for type: LLM)

type
enum<string>
required
Available options:
LLM
name
string
required

Integration name. Unique per (account, type).

config
object
required

Create config for an OpenAI LLM integration. api_key is required and is write-only (never returned in responses).

scopings
object[]

Visibility scoping rules. Defaults to account-wide.

Response

An integration object.

An LLM integration (type=LLM).

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

Config for an OpenAI LLM integration.