Skip to main content
The ax spaces commands are currently in BETA. The API may change without notice. A one-time warning is emitted on first use. The add-user and remove-user commands are in ALPHA.
The ax spaces commands let you create, retrieve, and manage spaces on the Arize platform.

ax spaces list

List all spaces, optionally filtered by organization.
ax spaces list [--organization-id <id>] [--limit <n>] [--cursor <cursor>]
OptionDescription
--organization-idFilter spaces by organization ID
--limit, -lMaximum number of results to return (default: 15)
--cursor, -cPagination cursor for the next page
--output, -oOutput format (table, json, csv, parquet) or file path
--verbose, -vEnable verbose logs
Examples:
ax spaces list
ax spaces list --organization-id org_abc123
ax spaces list --output spaces.json

ax spaces create

Create a new space within an organization.
ax spaces create --name <name> --organization-id <id> [--description <text>]
OptionDescription
--name, -nName for the new space (prompted if omitted)
--organization-idOrganization ID to create the space in (prompted if omitted)
--descriptionOptional description for the space
--output, -oOutput format (table, json, csv, parquet) or file path
--verbose, -vEnable verbose logs
Example:
ax spaces create --name "production" --organization-id org_abc123
ax spaces create --name "staging" --organization-id org_abc123 --description "Staging environment"

ax spaces get

Retrieve a single space by name or ID.
ax spaces get <name-or-id>
OptionDescription
--output, -oOutput format (table, json, csv, parquet) or file path
--verbose, -vEnable verbose logs
Example:
ax spaces get sp_abc123
ax spaces get "production"

ax spaces update

Update a space’s name or description. At least one of --name or --description must be provided.
ax spaces update <name-or-id> [--name <name>] [--description <text>]
OptionDescription
--name, -nNew name for the space
--descriptionNew description for the space
--output, -oOutput format (table, json, csv, parquet) or file path
--verbose, -vEnable verbose logs
Examples:
ax spaces update sp_abc123 --name "production-v2"
ax spaces update sp_abc123 --description "Main production environment"
ax spaces update sp_abc123 --name "prod" --description "Production"

ax spaces delete

Delete a space and all resources within it. This operation is irreversible.
ax spaces delete <name-or-id> [--force]
OptionDescription
--force, -fSkip the confirmation prompt
--verbose, -vEnable verbose logs
Deleting a space permanently removes all resources that belong to it — models, monitors, dashboards, datasets, custom metrics, and experiments. Without --force, you will be prompted to type the space name or ID to confirm.
Examples:
ax spaces delete sp_abc123 --force
ax spaces delete "production"

ax spaces add-user

Add a user to a space, or update their role if already a member (upsert semantics). The user must already be a member of the space’s parent organization.
ax spaces add-user <name-or-id> --user-id <id> --role <role>
OptionDescription
--user-idGlobal ID of the user to add (prompted if omitted)
--role, -rPredefined space role: admin, member, read-only, or annotator (prompted if omitted)
--output, -oOutput format (table, json, csv, parquet) or file path
--verbose, -vEnable verbose logs
Example:
ax spaces add-user sp_abc123 --user-id usr_xyz789 --role member

ax spaces remove-user

Remove a user from a space.
ax spaces remove-user <name-or-id> --user-id <id> [--force]
OptionDescription
--user-idGlobal ID of the user to remove (prompted if omitted)
--force, -fSkip the confirmation prompt
--verbose, -vEnable verbose logs
Examples:
ax spaces remove-user sp_abc123 --user-id usr_xyz789
ax spaces remove-user sp_abc123 --user-id usr_xyz789 --force