Skip to main content
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.
  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.
  3. A client library. Libraries like gql (Python) or 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.

API explorer

Open the in-app explorer, browse the schema, and run your first query or mutation.

Getting started

Grant developer access and get an API key to call the API from outside the app.

All mutations

The full, generated index of every mutation in the API.

Object graph

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. For reads, start from the root queries (viewer, account, node) and the 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.

​
About GraphQL

The GraphQL data query language is:
  • A specification. 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. 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 and join our community slack. Let’s build great things together.