---
canonical_url: "https://docs.composio.dev/toolkits/arize_ax"
markdown_url: "https://docs.composio.dev/toolkits/arize_ax.md"
product: "platform"
version: null
last_updated: null
---

# Arize AX

Arize AX is an AI engineering platform for tracing, evaluating, and improving AI applications through projects, datasets, prompts, experiments, traces, and spans.

- **Category:** artificial intelligence
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 24
- **Triggers:** 0
- **Slug:** `ARIZE_AX`
- **Version:** 00000000_00

## Tools

### Add Dataset Examples

**Slug:** `ARIZE_AX_ADD_DATASET_EXAMPLES`

Append arbitrary-field examples to an Arize dataset or a specified dataset version.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `examples` | array | Yes | Examples to append. Each object must have at least one arbitrary top-level field; do not include id, created_at, or updated_at. |
| `dataset_id` | string | Yes | Opaque, case-sensitive dataset ID; preserve any base64 padding. |
| `dataset_version_id` | string | No | Optional opaque dataset version ID to extend. Omit to use the latest version. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Experiment Runs

**Slug:** `ARIZE_AX_ADD_EXPERIMENT_RUNS`

Append one or more runs to an existing Arize experiment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `experiment_id` | string | Yes | Opaque, case-sensitive experiment ID; preserve any base64 padding. |
| `experiment_runs` | array | Yes | Runs to append. Each requires output and may include example_id plus arbitrary provider-supported top-level fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Dataset

**Slug:** `ARIZE_AX_CREATE_DATASET`

Create an Arize dataset in a space with an explicit initial array of examples.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique dataset name within the target space. |
| `examples` | array | Yes | Initial examples. Each object must have at least one arbitrary top-level field; do not include id, created_at, or updated_at. |
| `space_id` | string | Yes | Opaque, case-sensitive ID of the space in which to create the dataset; preserve any base64 padding. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Experiment

**Slug:** `ARIZE_AX_CREATE_EXPERIMENT`

Create an Arize experiment with initial runs, associated with exactly one dataset or space.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique experiment name within the selected dataset or space. |
| `space_id` | string | No | Space-backed experiment source. Provide exactly one of space_id or dataset_id. |
| `dataset_id` | string | No | Dataset-backed experiment source. Provide exactly one of dataset_id or space_id. |
| `experiment_runs` | array | Yes | Initial runs. Each requires output, may include example_id, and may include additional provider-supported top-level fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Prompt

**Slug:** `ARIZE_AX_CREATE_PROMPT`

Create an Arize prompt and its initial version in a space.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique prompt name within the target space. |
| `version` | object | Yes | Initial immutable prompt version, including its messages and provider configuration. |
| `space_id` | string | Yes | Opaque, case-sensitive ID of the space in which to create the prompt; preserve any base64 padding. |
| `description` | string | No | Human-readable prompt description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Prompt Version

**Slug:** `ARIZE_AX_CREATE_PROMPT_VERSION`

Create a new immutable version of an existing Arize prompt.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model` | string | No | Provider model name for this version. |
| `messages` | array | Yes | Prompt messages. At least one message is required. |
| `provider` | string ("OPEN_AI" | "AZURE_OPEN_AI" | "AWS_BEDROCK" | "VERTEX_AI" | "ANTHROPIC" | "CUSTOM") | Yes | Model provider used by this version. |
| `prompt_id` | string | Yes | Opaque, case-sensitive ID of the prompt to version; preserve any base64 padding. |
| `commit_message` | string | Yes | Description of the version change. |
| `provider_params` | object | No | Provider-specific Azure, Anthropic, Bedrock, or regional settings. |
| `invocation_params` | object | No | Model invocation settings. |
| `input_variable_format` | string ("F_STRING" | "MUSTACHE" | "NONE") | No | Prompt variable syntax. Arize defaults to F_STRING when omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Dataset

**Slug:** `ARIZE_AX_GET_DATASET`

Get one Arize dataset and its versions by dataset ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dataset_id` | string | Yes | Opaque, case-sensitive dataset ID; preserve any base64 padding. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Experiment

**Slug:** `ARIZE_AX_GET_EXPERIMENT`

Get one Arize experiment by its ID, without its experiment runs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `experiment_id` | string | Yes | Opaque, case-sensitive experiment ID; preserve any base64 padding. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project

**Slug:** `ARIZE_AX_GET_PROJECT`

Get one accessible Arize project by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Opaque, case-sensitive project ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Prompt

**Slug:** `ARIZE_AX_GET_PROMPT`

Get an Arize prompt with its current, explicitly selected, or labeled version.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label` | string | No | Label whose target version to embed, such as production. Mutually exclusive with version_id. |
| `prompt_id` | string | Yes | Opaque, case-sensitive prompt ID; preserve any base64 padding. |
| `version_id` | string | No | Specific prompt version to embed. Mutually exclusive with label. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Space

**Slug:** `ARIZE_AX_GET_SPACE`

Get one accessible Arize space by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `space_id` | string | Yes | Opaque, case-sensitive space ID; preserve any base64 padding. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Dataset Examples

**Slug:** `ARIZE_AX_LIST_DATASET_EXAMPLES`

List one page of examples from an Arize dataset or a specific dataset version, preserving user-defined example fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum examples to return in this page (1-500). |
| `cursor` | string | No | Opaque next_cursor from a previous page. Omit for the first page and pass it back unchanged. |
| `dataset_id` | string | Yes | Opaque, case-sensitive ID of the dataset whose examples to list. |
| `dataset_version_id` | string | No | Dataset version to read. Omit to use the current version. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Datasets

**Slug:** `ARIZE_AX_LIST_DATASETS`

List one page of Arize datasets, optionally filtered by space or dataset name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Case-insensitive substring to match against dataset names. |
| `limit` | integer | No | Maximum datasets to return in this page (1-100). |
| `cursor` | string | No | Opaque next_cursor from a previous page. Omit for the first page and pass it back unchanged. |
| `space_id` | string | No | Return only datasets in this space ID. |
| `space_name` | string | No | Case-insensitive substring to match against containing space names. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Experiment Runs

**Slug:** `ARIZE_AX_LIST_EXPERIMENT_RUNS`

List one page of runs and outputs for an Arize experiment, preserving additional run fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum experiment runs to return in this page (1-500). |
| `cursor` | string | No | Opaque next_cursor from a previous page. Omit for the first page and pass it back unchanged. |
| `experiment_id` | string | Yes | Opaque, case-sensitive ID of the experiment whose runs to list; preserve any base64 padding. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Experiments

**Slug:** `ARIZE_AX_LIST_EXPERIMENTS`

List one page of Arize experiments, optionally filtered by dataset, space, or name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Case-insensitive substring to match against experiment names. |
| `limit` | integer | No | Maximum experiments to return in this page (1-100). |
| `cursor` | string | No | Opaque next_cursor from a previous page; do not parse or construct it. |
| `space_id` | string | No | Return experiments in this space. |
| `dataset_id` | string | No | Return experiments associated with this dataset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Projects

**Slug:** `ARIZE_AX_LIST_PROJECTS`

List one page of accessible Arize projects, optionally filtered by space or project name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Case-insensitive substring to match against project names. |
| `limit` | integer | No | Maximum projects to return in this page. |
| `cursor` | string | No | Opaque next_cursor from a previous page. Omit for the first page and pass it back unchanged. |
| `space_id` | string | No | Return projects in this space ID. |
| `space_name` | string | No | Case-insensitive substring to match against containing space names. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Prompts

**Slug:** `ARIZE_AX_LIST_PROMPTS`

List one page of Arize prompts, optionally filtered by space or prompt name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Case-insensitive substring to match against prompt names. |
| `limit` | integer | No | Maximum prompts to return in this page (1-100). |
| `cursor` | string | No | Opaque next_cursor from a previous page. Omit for the first page and pass it back unchanged. |
| `space_id` | string | No | Return prompts in this space ID. |
| `space_name` | string | No | Case-insensitive substring to match against containing space names. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Prompt Versions

**Slug:** `ARIZE_AX_LIST_PROMPT_VERSIONS`

List one page of versions for an Arize prompt, newest first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum prompt versions to return in this page (1-100). |
| `cursor` | string | No | Opaque next_cursor from a previous page. Omit for the first page and pass it back unchanged. |
| `prompt_id` | string | Yes | Opaque, case-sensitive prompt ID; preserve any base64 padding. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Spaces

**Slug:** `ARIZE_AX_LIST_SPACES`

List one page of Arize spaces accessible to the connected API key, optionally filtered by organization or name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Case-insensitive substring to match against space names. |
| `limit` | integer | No | Maximum spaces to return in this page (1-100). |
| `cursor` | string | No | Opaque next_cursor from a previous page; do not parse or construct it. |
| `org_id` | string | No | Return only spaces in this organization ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Spans

**Slug:** `ARIZE_AX_LIST_SPANS`

Read one bounded page of spans for an Arize project using optional time and filter constraints.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum spans to return in this page (1-500). Use a small value when attributes contain model inputs or outputs. |
| `cursor` | string | No | Opaque next_cursor from a previous page; do not parse or construct it. |
| `filter` | string | No | Arize span filter expression. |
| `end_time` | string | No | Upper time bound in RFC 3339 format. |
| `project_id` | string | Yes | Project whose spans to query. |
| `start_time` | string | No | Inclusive lower time bound in RFC 3339 format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Traces

**Slug:** `ARIZE_AX_LIST_TRACES`

Read one bounded page of traces and nested spans for an Arize project using optional time and filter constraints; nested spans may be truncated per trace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum traces in this page (1-50). Each trace can contain many spans, so keep this small. |
| `cursor` | string | No | Opaque next_cursor from a previous page; do not parse or construct it. |
| `filter` | string | No | Arize trace/span filter expression. A trace matches when any span in it matches the expression. |
| `end_time` | string | No | Upper time bound as an RFC 3339 timestamp with a timezone. |
| `project_id` | string | Yes | Opaque, case-sensitive ID of the project whose traces to query. |
| `start_time` | string | No | Inclusive lower time bound as an RFC 3339 timestamp with a timezone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Dataset

**Slug:** `ARIZE_AX_UPDATE_DATASET`

Rename an existing Arize dataset.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | New unique name for the dataset within its space. |
| `dataset_id` | string | Yes | Opaque, case-sensitive dataset ID; preserve any base64 padding. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Dataset Examples

**Slug:** `ARIZE_AX_UPDATE_DATASET_EXAMPLES`

Update existing Arize dataset examples by ID, optionally creating a named dataset version. IDs that do not match existing examples are ignored.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `examples` | array | Yes | Example updates. Every object requires an id and may contain arbitrary replacement fields; do not include created_at or updated_at. |
| `dataset_id` | string | Yes | Opaque, case-sensitive dataset ID; preserve any base64 padding. |
| `new_version` | string | No | Optional name for a new dataset version containing the updates. |
| `dataset_version_id` | string | No | Optional source dataset version to update; omit to update the latest version. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Prompt

**Slug:** `ARIZE_AX_UPDATE_PROMPT`

Update or clear an Arize prompt's description.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `prompt_id` | string | Yes | Opaque, case-sensitive prompt ID; preserve any base64 padding. |
| `description` | string | Yes | New human-readable prompt description, or null to clear it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |