Skip to main content
The projects functions are currently in BETA. The API may change without notice. A one-time warning is emitted on first use.

​
List Projects

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

const { data: projects, pagination } = await listProjects({
  space: "my-space",  // space name or ID (optional)
  name: "customer",   // substring filter on project name (optional)
  limit: 10,
});

​
Create a Project

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

const project = await createProject({
  space: "my-space",  // space name or ID
  name: "your_project_name",
});

​
Get a Project

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

// By ID
const project = await getProject({ project: "your_project_id" });

// By name (requires space)
const project = await getProject({ project: "my-project", space: "my-space" });

​
Update a Project

Rename a project. The new name must be unique within the space. 
import { updateProject } from "@arizeai/ax-client";

const project = await updateProject({
  project: "my-project",  // project name or ID
  space: "my-space",      // required when project is a name
  name: "my-renamed-project",
});

​
Delete a Project

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

// By ID
await deleteProject({ project: "your_project_id" });

// By name (requires space)
await deleteProject({ project: "my-project", space: "my-space" });