Manage workspaces

Create, claim, browse, and delete workspaces. Afterward, use a workspace as the target for AI Studio resource operations. Adjacent task pages handle Catalogs, compute resources, and data sharing.

Prerequisites

  • Prepare credentials required by the AI Studio API.

  • Before claiming or deleting an existing workspace, obtain its ID from the workspace list.

For authentication, first read Prepare to call an API.

Call sequence

  1. First list workspaces to decide whether to use an existing workspace or create a new one.

  2. To create a workspace, submit a workspace-creation task, then use list workspace-creation tasks to confirm that the task succeeded and produced a workspace ID. To wait synchronously for the result, use Create a workspace.

  3. To handle a pending invitation, accept a workspace invitation. To claim a workspace for the current identity when it already has membership, claim the workspace.

  4. After creation, accepting an invitation, or claiming, list workspaces again to confirm that the target workspace is available. Use it as the target for later AI Studio requests.

  5. Before deletion, handle data-sharing cleanup requirements. After deletion, list workspaces again to confirm that it no longer appears.

API operations

Select or create a workspace

What you need to do

API operation

Use it when

Query accessible workspaces

List workspaces

Select an existing workspace, obtain its ID, or confirm creation and claim results.

Submit asynchronous creation

Submit a workspace-creation task

Create a workspace from the current console.

Track a creation task

List workspace-creation tasks

Confirm whether asynchronous creation produced a workspace ID.

Create synchronously

Create a workspace

Wait for a synchronous result.

Claim a workspace

Claim a workspace

Claim a workspace that already has membership for the current identity.

Accept an invitation

Accept a workspace invitation

The current identity has a pending workspace invitation.

Update the name

Update a workspace

Modify an existing workspace name.

Remove a workspace

What you need to do

API operation

Use it when

Delete a workspace

Delete a workspace

Data-sharing cleanup is complete and the target workspace is no longer needed.

Confirm the result

An asynchronously created workspace exists only after the task succeeds and returns a workspace ID. After synchronous creation, retain the returned ID and use List workspaces to confirm access. For a claim, use the action-page response to determine whether it was actually claimed. After deletion, also use the list to confirm that the target workspace no longer appears.

Limitations and notes

  • You must meet data-sharing cleanup requirements before deleting a workspace.

  • After successfully submitting a deletion request, still query the workspace list to confirm the result.

Next steps

Last updated on