Skip to main content

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.

The spaces functions are currently in BETA. The API may change without notice. A one-time warning is emitted on first use.

​
List Spaces

import { listSpaces } from "@arizeai/ax-client";

const { data: spaces, pagination } = await listSpaces({
  organizationId: "your_organization_id",  // optional
  limit: 10,
});

​
Create a Space

import { createSpace } from "@arizeai/ax-client";

const space = await createSpace({
  organizationId: "your_organization_id",
  name: "your_space_name",
  description: "optional description",
});

​
Get a Space

import { getSpace } from "@arizeai/ax-client";

// By space ID
const space = await getSpace({ space: "your_space_id" });

// By space name
const space = await getSpace({ space: "my-space" });

​
Update a Space

import { updateSpace } from "@arizeai/ax-client";

const space = await updateSpace({
  space: "my-space",  // space name or ID
  name: "updated_space_name",
  description: "updated description",  // optional
});

​
Delete a Space

This operation is irreversible. Deleting a space permanently removes all resources that belong to it (models, monitors, dashboards, datasets, custom metrics, etc.).
import { deleteSpace } from "@arizeai/ax-client";

await deleteSpace({ space: "my-space" });  // space name or ID

​
Add a User to a Space

Uses upsert semantics — if the user is already a member, their role is updated. The user must already be a member of the space’s parent organization. Requires space admin role or ROLE_BINDING_CREATE permission. 
import { addSpaceUser } from "@arizeai/ax-client";

const membership = await addSpaceUser({
  spaceId: "your_space_id",
  userId: "your_user_id",
  role: { type: "predefined", name: "member" },
});

​
Remove a User from a Space

Removes the user’s space membership and all RBAC role bindings on the space. Requires space admin role or ROLE_BINDING_DELETE permission. 
import { removeSpaceUser } from "@arizeai/ax-client";

await removeSpaceUser({
  spaceId: "your_space_id",
  userId: "your_user_id",
});