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

# Arize AX

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

![Arize AX logo](https://mintcdn.com/composio-preview/6S5R4NszqpnVIZRD/images/toolkits/arize_ax.svg?fit=max\&auto=format\&n=6S5R4NszqpnVIZRD\&q=85\&s=39a2246e97928af9ad76714ca802a689)

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

## Tools

> [accordion] Add Dataset Examples
>
> **Slug:** `ARIZE_AX_ADD_DATASET_EXAMPLES`
>
> Append arbitrary-field examples to an Arize dataset or a specified dataset version.
>
> #### Input Parameters
>
> **examples** `array` *required*
>
> 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` *required*
>
> Opaque, case-sensitive dataset ID; preserve any base64 padding.
>
> **dataset\_version\_id** `string`
>
> Optional opaque dataset version ID to extend. Omit to use the latest version.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Experiment Runs
>
> **Slug:** `ARIZE_AX_ADD_EXPERIMENT_RUNS`
>
> Append one or more runs to an existing Arize experiment.
>
> #### Input Parameters
>
> **experiment\_id** `string` *required*
>
> Opaque, case-sensitive experiment ID; preserve any base64 padding.
>
> **experiment\_runs** `array` *required*
>
> Runs to append. Each requires output and may include example\_id plus arbitrary provider-supported top-level fields.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Dataset
>
> **Slug:** `ARIZE_AX_CREATE_DATASET`
>
> Create an Arize dataset in a space with an explicit initial array of examples.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Unique dataset name within the target space.
>
> **examples** `array` *required*
>
> 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` *required*
>
> Opaque, case-sensitive ID of the space in which to create the dataset; preserve any base64 padding.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Experiment
>
> **Slug:** `ARIZE_AX_CREATE_EXPERIMENT`
>
> Create an Arize experiment with initial runs, associated with exactly one dataset or space.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Unique experiment name within the selected dataset or space.
>
> **space\_id** `string`
>
> Space-backed experiment source. Provide exactly one of space\_id or dataset\_id.
>
> **dataset\_id** `string`
>
> Dataset-backed experiment source. Provide exactly one of dataset\_id or space\_id.
>
> **experiment\_runs** `array` *required*
>
> Initial runs. Each requires output, may include example\_id, and may include additional provider-supported top-level fields.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Prompt
>
> **Slug:** `ARIZE_AX_CREATE_PROMPT`
>
> Create an Arize prompt and its initial version in a space.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Unique prompt name within the target space.
>
> **version** `object` *required*
>
> Initial immutable prompt version, including its messages and provider configuration.
>
> **space\_id** `string` *required*
>
> Opaque, case-sensitive ID of the space in which to create the prompt; preserve any base64 padding.
>
> **description** `string`
>
> Human-readable prompt description.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Prompt Version
>
> **Slug:** `ARIZE_AX_CREATE_PROMPT_VERSION`
>
> Create a new immutable version of an existing Arize prompt.
>
> #### Input Parameters
>
> **model** `string`
>
> Provider model name for this version.
>
> **messages** `array` *required*
>
> Prompt messages. At least one message is required.
>
> **provider** `string ("OPEN_AI" | "AZURE_OPEN_AI" | "AWS_BEDROCK" | "VERTEX_AI" | "ANTHROPIC" | "CUSTOM")` *required*
>
> Model provider used by this version.
>
> **prompt\_id** `string` *required*
>
> Opaque, case-sensitive ID of the prompt to version; preserve any base64 padding.
>
> **commit\_message** `string` *required*
>
> Description of the version change.
>
> **provider\_params** `object`
>
> Provider-specific Azure, Anthropic, Bedrock, or regional settings.
>
> **invocation\_params** `object`
>
> Model invocation settings.
>
> **input\_variable\_format** `string ("F_STRING" | "MUSTACHE" | "NONE")`
>
> Prompt variable syntax. Arize defaults to F\_STRING when omitted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Dataset
>
> **Slug:** `ARIZE_AX_GET_DATASET`
>
> Get one Arize dataset and its versions by dataset ID.
>
> #### Input Parameters
>
> **dataset\_id** `string` *required*
>
> Opaque, case-sensitive dataset ID; preserve any base64 padding.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Experiment
>
> **Slug:** `ARIZE_AX_GET_EXPERIMENT`
>
> Get one Arize experiment by its ID, without its experiment runs.
>
> #### Input Parameters
>
> **experiment\_id** `string` *required*
>
> Opaque, case-sensitive experiment ID; preserve any base64 padding.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Project
>
> **Slug:** `ARIZE_AX_GET_PROJECT`
>
> Get one accessible Arize project by its ID.
>
> #### Input Parameters
>
> **project\_id** `string` *required*
>
> Opaque, case-sensitive project ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Prompt
>
> **Slug:** `ARIZE_AX_GET_PROMPT`
>
> Get an Arize prompt with its current, explicitly selected, or labeled version.
>
> #### Input Parameters
>
> **label** `string`
>
> Label whose target version to embed, such as production. Mutually exclusive with version\_id.
>
> **prompt\_id** `string` *required*
>
> Opaque, case-sensitive prompt ID; preserve any base64 padding.
>
> **version\_id** `string`
>
> Specific prompt version to embed. Mutually exclusive with label.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Space
>
> **Slug:** `ARIZE_AX_GET_SPACE`
>
> Get one accessible Arize space by its ID.
>
> #### Input Parameters
>
> **space\_id** `string` *required*
>
> Opaque, case-sensitive space ID; preserve any base64 padding.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Maximum examples to return in this page (1-500).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous page. Omit for the first page and pass it back unchanged.
>
> **dataset\_id** `string` *required*
>
> Opaque, case-sensitive ID of the dataset whose examples to list.
>
> **dataset\_version\_id** `string`
>
> Dataset version to read. Omit to use the current version.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Datasets
>
> **Slug:** `ARIZE_AX_LIST_DATASETS`
>
> List one page of Arize datasets, optionally filtered by space or dataset name.
>
> #### Input Parameters
>
> **name** `string`
>
> Case-insensitive substring to match against dataset names.
>
> **limit** `integer`
>
> Maximum datasets to return in this page (1-100).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous page. Omit for the first page and pass it back unchanged.
>
> **space\_id** `string`
>
> Return only datasets in this space ID.
>
> **space\_name** `string`
>
> Case-insensitive substring to match against containing space names.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Maximum experiment runs to return in this page (1-500).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous page. Omit for the first page and pass it back unchanged.
>
> **experiment\_id** `string` *required*
>
> Opaque, case-sensitive ID of the experiment whose runs to list; preserve any base64 padding.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Experiments
>
> **Slug:** `ARIZE_AX_LIST_EXPERIMENTS`
>
> List one page of Arize experiments, optionally filtered by dataset, space, or name.
>
> #### Input Parameters
>
> **name** `string`
>
> Case-insensitive substring to match against experiment names.
>
> **limit** `integer`
>
> Maximum experiments to return in this page (1-100).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous page; do not parse or construct it.
>
> **space\_id** `string`
>
> Return experiments in this space.
>
> **dataset\_id** `string`
>
> Return experiments associated with this dataset.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Projects
>
> **Slug:** `ARIZE_AX_LIST_PROJECTS`
>
> List one page of accessible Arize projects, optionally filtered by space or project name.
>
> #### Input Parameters
>
> **name** `string`
>
> Case-insensitive substring to match against project names.
>
> **limit** `integer`
>
> Maximum projects to return in this page.
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous page. Omit for the first page and pass it back unchanged.
>
> **space\_id** `string`
>
> Return projects in this space ID.
>
> **space\_name** `string`
>
> Case-insensitive substring to match against containing space names.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Prompts
>
> **Slug:** `ARIZE_AX_LIST_PROMPTS`
>
> List one page of Arize prompts, optionally filtered by space ID, space name, or prompt name. Name filters use case-insensitive substring matching.
>
> #### Input Parameters
>
> **name** `string`
>
> Case-insensitive substring to match against prompt names.
>
> **limit** `integer`
>
> Maximum prompts to return in this page (1-100).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous page. Omit for the first page and pass it back unchanged.
>
> **space\_id** `string`
>
> Return prompts in this space ID.
>
> **space\_name** `string`
>
> Case-insensitive substring to match against containing space names.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Prompt Versions
>
> **Slug:** `ARIZE_AX_LIST_PROMPT_VERSIONS`
>
> List one page of versions for an Arize prompt, newest first.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum prompt versions to return in this page (1-100).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous page. Omit for the first page and pass it back unchanged.
>
> **prompt\_id** `string` *required*
>
> Opaque, case-sensitive prompt ID; preserve any base64 padding.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Spaces
>
> **Slug:** `ARIZE_AX_LIST_SPACES`
>
> List one page of Arize spaces accessible to the connected API key, optionally filtered by organization or a case-insensitive substring of the space name.
>
> #### Input Parameters
>
> **name** `string`
>
> Case-insensitive substring to match against space names.
>
> **limit** `integer`
>
> Maximum spaces to return in this page (1-100).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous page; do not parse or construct it.
>
> **org\_id** `string`
>
> Return only spaces in this organization ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Maximum spans to return in this page (1-500). Use a small value when attributes contain model inputs or outputs.
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous page; do not parse or construct it.
>
> **filter** `string`
>
> Arize span filter expression.
>
> **end\_time** `string`
>
> Upper time bound in RFC 3339 format.
>
> **project\_id** `string` *required*
>
> Project whose spans to query.
>
> **start\_time** `string`
>
> Inclusive lower time bound in RFC 3339 format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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. A filter selects traces containing at least one matching span; nested spans may be truncated per trace.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum traces in this page (1-50). Each trace can contain many spans, so keep this small.
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous page; do not parse or construct it.
>
> **filter** `string`
>
> Arize trace/span filter expression. A trace matches when any span in it matches the expression.
>
> **end\_time** `string`
>
> Upper time bound as an RFC 3339 timestamp with a timezone.
>
> **project\_id** `string` *required*
>
> Opaque, case-sensitive ID of the project whose traces to query.
>
> **start\_time** `string`
>
> Inclusive lower time bound as an RFC 3339 timestamp with a timezone.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Dataset
>
> **Slug:** `ARIZE_AX_UPDATE_DATASET`
>
> Rename an existing Arize dataset.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> New unique name for the dataset within its space.
>
> **dataset\_id** `string` *required*
>
> Opaque, case-sensitive dataset ID; preserve any base64 padding.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **examples** `array` *required*
>
> Example updates. Every object requires an id and may contain arbitrary replacement fields; do not include created\_at or updated\_at.
>
> **dataset\_id** `string` *required*
>
> Opaque, case-sensitive dataset ID; preserve any base64 padding.
>
> **new\_version** `string`
>
> Optional name for a new dataset version containing the updates.
>
> **dataset\_version\_id** `string`
>
> Optional source dataset version to update; omit to update the latest version.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Prompt
>
> **Slug:** `ARIZE_AX_UPDATE_PROMPT`
>
> Update or clear an Arize prompt's description.
>
> #### Input Parameters
>
> **prompt\_id** `string` *required*
>
> Opaque, case-sensitive prompt ID; preserve any base64 padding.
>
> **description** `string` *required*
>
> New human-readable prompt description, or null to clear it.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
