> ## 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.
# GraphQL API
> Programmatically query and mutate Spaces, monitors, dashboards, projects, datasets, and prompts in Arize AX using the GraphQL API and its rate limits.
The Arize GraphQL API gives you programmatic access to almost everything you can do in the Arize AX app: create and update monitors, dashboards, datasets, prompts, evaluators, and more, or read back data for your own tooling. A single call can return exactly the nested data you ask for, which means fewer round trips than an equivalent set of REST calls.
Use it to:
* Bulk create or update monitors with complex filters or baselines
* Export existing configuration (monitors, dashboards, custom metrics), edit it, and write it back
* Build automation that integrates Arize AX with your internal systems or CI pipelines
## Three ways to use the API
1. **The API explorer.** An in-app GraphiQL editor that runs against the live schema using your logged-in session. Best for browsing the schema, autocompleting fields, and trying out a query or mutation before you script it. See [API explorer](/docs/ax/graphql-reference/overview/api-explorer).
2. **cURL (or any HTTP client).** `POST` a JSON body containing a `query` string to `https://app.arize.com/graphql` with an `x-api-key` header. Good for quick scripts and CI jobs. See [Forming calls](/docs/ax/graphql-reference/overview/how-to-use-graphql/forming-calls).
3. **A client library.** Libraries like [gql](https://github.com/graphql-python/gql) (Python) or [graphql-request](https://github.com/prisma-labs/graphql-request) (JavaScript) handle request formatting and typing for you, and are the best fit for anything beyond a one-off call.
All three talk to the same endpoint and schema, so an operation you prototype in the explorer runs unchanged from a script.
Open the in-app explorer, browse the schema, and run your first query or mutation.
Grant developer access and get an API key to call the API from outside the app.
The full, generated index of every mutation in the API.
The types you traverse from the root queries to reach everything else.
## Find the operation you need
The API explorer's Docs sidebar always shows the complete, live schema. This reference is generated from that same schema and documents it area by area; it's the fastest way to find the right mutation or query without writing introspection queries yourself.
Each guide below walks through a product area task-by-task; each reference page lists every mutation for that area with its arguments, return type, and a minimal example.
| Area | Guide | Mutation reference |
| - | - | - |
| Admin (Spaces, organizations, users, API keys, SAML) | [Admin guide](/docs/ax/graphql-reference/guides/admin) | [Admin mutations](/docs/ax/graphql-reference/mutations/admin) |
| Monitors | [Monitor guide](/docs/ax/graphql-reference/guides/monitors) | [Monitor mutations](/docs/ax/graphql-reference/mutations/monitors) |
| Dashboards | [Dashboard guide](/docs/ax/graphql-reference/guides/dashboards) | [Dashboard mutations](/docs/ax/graphql-reference/mutations/dashboards) |
| Projects and models (also custom metrics, cost configs, trace filters) | [Project and model guide](/docs/ax/graphql-reference/guides/projects-and-models) | [Project and model mutations](/docs/ax/graphql-reference/mutations/projects-and-models) |
| Data import (file and table import, integration keys, BYOB) | [Data import guide](/docs/ax/graphql-reference/guides/data-import) | [Data import mutations](/docs/ax/graphql-reference/mutations/data-import) |
| Evaluators and tasks | [Evaluator and task guide](/docs/ax/graphql-reference/guides/evaluators-and-tasks) | [Evaluator and task mutations](/docs/ax/graphql-reference/mutations/evaluators-and-tasks) |
| Datasets and annotations | [Dataset and annotation guide](/docs/ax/graphql-reference/guides/datasets-and-annotations) | [Dataset and annotation mutations](/docs/ax/graphql-reference/mutations/datasets-and-annotations) |
| Prompts | [Prompt guide](/docs/ax/graphql-reference/guides/prompts) | [Prompt mutations](/docs/ax/graphql-reference/mutations/prompts) |
| LLM integrations | [LLM integration guide](/docs/ax/graphql-reference/guides/llm-integrations) | [LLM integration mutations](/docs/ax/graphql-reference/mutations/llm-integrations) |
| Managed agents and Signal | [Managed agent and Signal guide](/docs/ax/graphql-reference/guides/managed-agents-and-signal) | [Managed agent and Signal mutations](/docs/ax/graphql-reference/mutations/managed-agents-and-signal) |
For reads, start from the [root queries](/docs/ax/graphql-reference/queries/root-queries) (`viewer`, `account`, `node`) and the [object graph](/docs/ax/graphql-reference/queries/object-graph) they lead into, rather than an area-by-area index; most data is reached by traversing from `viewer.spaces` or `node(id: ...)`.
Queries on the Arize GraphQL API are available to all accounts. Mutations are available to enterprise-grade customers. To upgrade your account contact [support@arize.com](mailto:support@arize.com).
### About GraphQL
The [GraphQL](https://graphql.github.io/) data query language is:
* **A** [**specification**](https://graphql.github.io/graphql-spec/June2018/)**.** The spec determines the validity of the schema on the API server. The schema determines the validity of client calls.
* **Strongly typed.** The schema defines an API's type system and all object relationships.
* **Introspective.** A client can query the schema for details about the schema.
* **Hierarchical.** The shape of a GraphQL call mirrors the shape of the JSON data it returns. Nested fields let you query for and receive only the data you specify in a single round trip.
* **An application layer.** GraphQL is not a storage model or a database query language. The *graph* refers to graph structures defined in the schema, where `nodes` define objects and `edges` define relationships between objects. The API traverses and returns application data based on the schema definitions, independent of how the data is stored.
For a fuller walkthrough of this terminology, see [How to use GraphQL](/docs/ax/graphql-reference/overview/how-to-use-graphql). The GraphQL API is being actively iterated on, so some aspects may change; this reference reflects a schema snapshot and may lag the latest release. The explorer is always current.
We would love to hear from you! Please reach out to [support@arize.com](mailto:support@arize.com) and join our [community slack](https://arize-ai.slack.com). Let's build great things together.