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 organizations functions are currently in ALPHA. The API may change without notice. A one-time warning is emitted on first use.

​
List Organizations

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

const { data: organizations, pagination } = await listOrganizations({
  name: "platform",  // optional substring filter on organization name
  limit: 10,
});

​
Create an Organization

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

const org = await createOrganization({
  name: "my-organization",
  description: "Organization for the platform engineering team",  // optional
});
console.log(org.id);

​
Get an Organization

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

// By ID
const org = await getOrganization({ organization: "org_12345" });

// By name
const org = await getOrganization({ organization: "my-organization" });
console.log(org);

​
Update an Organization

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

const org = await updateOrganization({
  organization: "my-organization",  // organization name or ID
  name: "my-organization-renamed",  // optional
  description: "Updated description",  // optional
});
console.log(org);

​
Delete an Organization

This operation is irreversible. It deletes the organization and all resources that belong to it, including all spaces and their contents (projects, experiments, evaluators, models, monitors, dashboards, datasets, annotation configs, annotation queues, custom metrics) as well as organization-level resources (integrations, cost configurations, SAML identity providers, and API keys).
import { deleteOrganization } from "@arizeai/ax-client";

await deleteOrganization({ organization: "my-organization" });