The spaces client methods are currently in BETA. The API may change without notice. A one-time warning is emitted on first use.
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 ID
- Create new spaces within an organization
- Update a space’s name or description
- Delete spaces and all their resources
List Spaces
List all spaces you have access to, with optional filtering by organization.
resp = client.spaces.list(
organization_id="your-org-id", # optional
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")