---
title: "Workspaces"
description: "Generated TypeScript Management SDK methods for Workspaces."
---

> Documentation Index
> Fetch the complete documentation index at: https://nexus.microvoid.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Workspaces

These methods are generated from the Admin OpenAPI contract. They configure the control plane; they do not send model requests.

| Method             | HTTP     | Path                                 | Reference                                                |
| ------------------ | -------- | ------------------------------------ | -------------------------------------------------------- |
| `archiveWorkspace` | `DELETE` | `/admin/v1/workspaces/{workspaceId}` | [API](/api-reference/admin/workspaces/archive-workspace) |
| `createWorkspace`  | `POST`   | `/admin/v1/workspaces`               | [API](/api-reference/admin/workspaces/create-workspace)  |
| `getWorkspace`     | `GET`    | `/admin/v1/workspaces/{workspaceId}` | [API](/api-reference/admin/workspaces/get-workspace)     |
| `listWorkspaces`   | `GET`    | `/admin/v1/workspaces`               | [API](/api-reference/admin/workspaces/list-workspaces)   |
| `updateWorkspace`  | `PATCH`  | `/admin/v1/workspaces/{workspaceId}` | [API](/api-reference/admin/workspaces/update-workspace)  |

## Method signatures

### `archiveWorkspace`

```ts
nexus.archiveWorkspace(
  input: AdminOperationInput<"archiveWorkspace">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"archiveWorkspace">>
```

Archive a workspace

### `createWorkspace`

```ts
nexus.createWorkspace(
  input: AdminOperationInput<"createWorkspace">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"createWorkspace">>
```

Create a workspace

### `getWorkspace`

```ts
nexus.getWorkspace(
  input: AdminOperationInput<"getWorkspace">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"getWorkspace">>
```

Get a workspace

### `listWorkspaces`

```ts
nexus.listWorkspaces(
  input: AdminOperationInput<"listWorkspaces">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"listWorkspaces">>
```

List workspaces visible to the current management principal

### `updateWorkspace`

```ts
nexus.updateWorkspace(
  input: AdminOperationInput<"updateWorkspace">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"updateWorkspace">>
```

Update a workspace

Source: https://nexus.microvoid.io/management-sdk/reference/workspaces/index.mdx