Spaces

The spaces client methods 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 methods are in ALPHA.

Manage spaces programmatically. Create, list, retrieve, and update spaces within your Arize organization.

Key Capabilities

List spaces you have access to within an organization
Retrieve space details by name or ID
Create new spaces within an organization
Update a space’s name or description
Delete spaces and all their resources
Add or remove users (space memberships)

List Spaces

List all spaces you have access to, with optional filtering by organization or name.

resp = client.spaces.list(
    organization_id="your-org-id",  # optional
    name="my-space",                # optional substring filter
    limit=50,
)

for space in resp.spaces:
    print(space.id, space.name)

For details on pagination, field introspection, and data conversion (to dict/JSON/DataFrame), see Response Objects.

Create a Space

Create a new space within an organization. Space names must be unique within the target organization.

space = client.spaces.create(
    name="my-new-space",
    organization_id="your-org-id",
    description="Optional description of the space",  # optional
)

print(space.id, space.name)

Get a Space

Retrieve a specific space by name or ID.

space = client.spaces.get(space="your-space-name-or-id")

print(space.id, space.name)

Update a Space

Update an existing space’s name or description. At least one of name or description must be provided.

space = client.spaces.update(
    space="your-space-name-or-id",
    name="updated-space-name",
    description="Updated description",  # optional
)

print(space.id, space.name)

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.).

client.spaces.delete(space="your-space-name-or-id")

Add a User to a Space

Add a user to a space, or update their role if they’re already a member (upsert). The user must already be a member of the space’s parent organization — auto-enrollment is not performed. Role constraints:

Users with an annotator account role can only be assigned the annotator predefined space role.
Users with a non-annotator account role cannot be assigned the annotator predefined space role.

Requires space admin (for predefined roles) or ROLE_BINDING_CREATE permission (for custom roles).

from arize.spaces.types import PredefinedSpaceRole

membership = client.spaces.add_user(
    space="your-space-name-or-id",
    user_id="your-user-id",
    role=PredefinedSpaceRole(name="member"),  # "admin", "member", "read-only", or "annotator"
)

print(membership.id, membership.user_id, membership.role)

To assign a custom RBAC role instead:

from arize.spaces.types import CustomSpaceRole

membership = client.spaces.add_user(
    space="your-space-name-or-id",
    user_id="your-user-id",
    role=CustomSpaceRole(id="your-custom-role-id"),
)

Remove a User from a Space

Remove a user from a space. This removes both the legacy space-membership row and any RBAC role bindings for the user on this space. Requires space admin (legacy auth) or ROLE_BINDING_DELETE permission (RBAC).

client.spaces.remove_user(
    space="your-space-name-or-id",
    user_id="your-user-id",
)

print("User removed from space")

API reference

API clients

Key Capabilities

List Spaces

Create a Space

Get a Space

Update a Space

Delete a Space

Add a User to a Space

Remove a User from a Space

​Key Capabilities

​List Spaces

​Create a Space

​Get a Space

​Update a Space

​Delete a Space

​Add a User to a Space

​Remove a User from a Space

Key Capabilities

List Spaces

Create a Space

Get a Space

Update a Space

Delete a Space

Add a User to a Space

Remove a User from a Space