> ## Documentation Index
> Fetch the complete documentation index at: https://arize-ax.mintlify.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# AI Integrations

> Manage AI integrations with the AX CLI

<Note>
  The `ax ai-integrations` commands are currently in **ALPHA**. The API may change without notice. A one-time warning is emitted on first use.
</Note>

The `ax ai-integrations` commands let you create and manage LLM provider integrations on the Arize platform. AI integrations store provider credentials and configuration used by evaluators and other Arize features.

## `ax ai-integrations list`

List AI integrations, optionally filtered by space.

```bash theme={null}
ax ai-integrations list [--name <filter>] [--space <name_or_id>] [--limit <n>] [--cursor <cursor>]
```

| Option     | Description                                           |
| ---------- | ----------------------------------------------------- |
| `--name`   | Case-insensitive substring filter on integration name |
| `--space`  | Filter integrations by space name or ID               |
| `--limit`  | Maximum number of results to return (default: 15)     |
| `--cursor` | Pagination cursor for the next page                   |

**Examples:**

```bash theme={null}
ax ai-integrations list
ax ai-integrations list --space sp_abc123 --output integrations.json
```

## `ax ai-integrations create`

Create a new AI integration.

```bash theme={null}
ax ai-integrations create --name <name> --provider <provider> [options]
```

| Option                       | Description                                                                                                   |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `--name`                     | Integration name (must be unique within the account)                                                          |
| `--provider`                 | LLM provider: `openAI`, `azureOpenAI`, `awsBedrock`, `vertexAI`, `anthropic`, `custom`, `nvidiaNim`, `gemini` |
| `--api-key`                  | API key for the provider (write-only, never returned)                                                         |
| `--base-url`                 | Custom base URL for the provider                                                                              |
| `--model-name`               | Supported model name (repeat for multiple, e.g. `--model-name gpt-4o --model-name gpt-4o-mini`)               |
| `--enable-default-models`    | Enable the provider's default model list (flag)                                                               |
| `--function-calling-enabled` | Enable function/tool calling (flag)                                                                           |
| `--auth-type`                | Authentication type: `default`, `proxy_with_headers`, `bearer_token`                                          |
| `--headers`                  | Custom headers as a JSON object or path to a JSON file                                                        |
| `--provider-metadata`        | Provider-specific metadata as a JSON object or path to a JSON file                                            |

**Provider-specific requirements:**

| Provider     | Required `--provider-metadata` fields                                     |
| ------------ | ------------------------------------------------------------------------- |
| `awsBedrock` | `{"role_arn": "..."}`                                                     |
| `vertexAI`   | `{"project_id": "...", "location": "...", "project_access_label": "..."}` |

**Examples:**

```bash theme={null}
# OpenAI integration
ax ai-integrations create \
  --name "OpenAI Production" \
  --provider openAI \
  --api-key sk-... \
  --model-name gpt-4o \
  --model-name gpt-4o-mini \
  --enable-default-models

# AWS Bedrock integration
ax ai-integrations create \
  --name "Bedrock Production" \
  --provider awsBedrock \
  --provider-metadata '{"role_arn": "arn:aws:iam::123456789:role/BedrockRole"}'
```

## `ax ai-integrations get`

Get an AI integration by name or ID.

```bash theme={null}
ax ai-integrations get <name-or-id> [--space <name_or_id>]
```

| Option    | Description                                                           |
| --------- | --------------------------------------------------------------------- |
| `--space` | Space name or ID (required when using integration name instead of ID) |

**Examples:**

```bash theme={null}
ax ai-integrations get ai_abc123
ax ai-integrations get "My OpenAI Integration" --space my-space
```

## `ax ai-integrations update`

Update an AI integration by name or ID. Only the fields you provide are updated. At least one option must be specified.

```bash theme={null}
ax ai-integrations update <name-or-id> [--space <id>] [options]
```

| Option                                                       | Description                                                                            |
| ------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
| `--space`                                                    | Space name or ID (required when using an integration name instead of ID)               |
| `--name`                                                     | Updated integration name                                                               |
| `--provider`                                                 | Updated LLM provider                                                                   |
| `--api-key`                                                  | New API key (write-only)                                                               |
| `--base-url`                                                 | Updated custom base URL                                                                |
| `--model-name`                                               | Supported model names (repeat for multiple; replaces existing list)                    |
| `--enable-default-models / --no-enable-default-models`       | Enable or disable the provider's default model list                                    |
| `--function-calling-enabled / --no-function-calling-enabled` | Enable or disable function calling                                                     |
| `--auth-type`                                                | Updated authentication type                                                            |
| `--headers`                                                  | Custom headers as JSON or file path. Pass `'null'` to clear existing headers           |
| `--provider-metadata`                                        | Provider-specific metadata as JSON or file path. Pass `'null'` to clear                |
| `--scopings`                                                 | Visibility scoping rules as a JSON array or file path (replaces all existing scopings) |

**Examples:**

```bash theme={null}
ax ai-integrations update ai_abc123 --name "OpenAI Staging"
ax ai-integrations update "Production OpenAI" --space sp_abc123 --api-key sk-new-key
ax ai-integrations update ai_abc123 --model-name gpt-4o --model-name gpt-4.1
ax ai-integrations update ai_abc123 --scopings '[{"space_id": "sp_abc"}]'
```

## `ax ai-integrations delete`

Delete an AI integration. This operation is irreversible.

```bash theme={null}
ax ai-integrations delete <name-or-id> [--space <id>] [--force]
```

| Option    | Description                                                              |
| --------- | ------------------------------------------------------------------------ |
| `--space` | Space name or ID (required when using an integration name instead of ID) |
| `--force` | Skip the confirmation prompt                                             |

**Examples:**

```bash theme={null}
ax ai-integrations delete ai_abc123
ax ai-integrations delete "Production OpenAI" --space sp_abc123 --force
```