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 ax organizations commands are currently in ALPHA. The API may change without notice. A one-time warning is emitted on first use.
The ax organizations commands let you create, retrieve, and manage organizations on the Arize platform.

ax organizations list

List organizations the authenticated user has access to.
ax organizations list [--name <filter>] [--limit <n>] [--cursor <cursor>]
OptionDescription
--nameFilter organizations by name (case-insensitive substring match)
--limitMaximum number of results to return (default: 50)
--cursorPagination cursor for the next page
Examples:
ax organizations list
ax organizations list --name "acme" --output orgs.json

ax organizations get

Get an organization by name or ID.
ax organizations get <name-or-id>
Examples:
ax organizations get org_abc123
ax organizations get "Acme Corp"

ax organizations create

Create a new organization. Organization names must be unique within the account.
ax organizations create --name <name> [--description <text>]
OptionDescription
--nameOrganization name (must be unique, max 255 characters)
--descriptionOptional description of the organization (max 1000 characters)
Example:
ax organizations create --name "Acme Corp" --description "Main organization"

ax organizations update

Update an organization’s metadata. At least one of --name or --description must be provided.
ax organizations update <name-or-id> [--name <name>] [--description <text>]
OptionDescription
--nameNew organization name (max 255 characters)
--descriptionNew description (max 1000 characters). Pass an empty string to clear.
Examples:
ax organizations update org_abc123 --name "Acme Corp v2"
ax organizations update org_abc123 --description "Updated description"

ax organizations add-user

Add a user to an organization, or update their role if they are already a member (upsert semantics).
ax organizations add-user <name-or-id> --user-id <id> --role <role>
OptionDescription
--user-idGlobal ID of the user to add
--role, -rPredefined organization role: admin, member, read-only, or annotator
Example:
ax organizations add-user org_abc123 --user-id usr_xyz789 --role member

ax organizations remove-user

Remove a user from an organization. Also removes the user from all child spaces (membership cascade).
ax organizations remove-user <name-or-id> --user-id <id> [--force]
OptionDescription
--user-idGlobal ID of the user to remove
--force, -fSkip the confirmation prompt
Examples:
ax organizations remove-user org_abc123 --user-id usr_xyz789
ax organizations remove-user org_abc123 --user-id usr_xyz789 --force