Delete workspace

Overview

A workspace is a private file system your agents keep between sessions. Several agents can share one. These endpoints manage the workspace record: its name, metadata, and network policy. None of them start the workspace or add compute cost. The workspace starts only when an agent first reads, writes, or runs something in it. Every request is scoped to your tenant.

Endpoints

List workspacesGET/v1/workspaces

List workspaces.

Lists your tenant's workspaces newest first, one page at a time. Pass nextCursor as cursor to get the next page. The workspace reserved for the platform-managed ba assist agent is never listed.

Request

Requires bearer authentication.

Returns 200 OK as application/json. A page of workspaces.

Response schema: WorkspaceList.

{
  "data": [
    {
      "id": "ws_3Vb8Ny6HpU1cGf4M",
      "tenantId": "ten_8Hq2Zr5WcY1bJt6D",
      "name": "Release files",
      "userId": "user_42",
      "metadata": {
        "project": "docs"
      },
      "networkPolicy": {
        "mode": "allowlist",
        "allowedHosts": [
          "registry.npmjs.org"
        ]
      },
      "createdAt": "2026-07-10T10:00:00.000Z",
      "updatedAt": "2026-07-10T10:00:00.000Z"
    }
  ],
  "nextCursor": null
}

Errors

See REST errors for the error envelope and shared codes.

cURL

curl "$BLAZING_AGENTS_BASE_URL/v1/workspaces" \
  --header "Authorization: Bearer $BLAZING_AGENTS_API_KEY"

Create workspacePOST/v1/workspaces

Create a workspace.

Creates a private file system your agents can keep between sessions. Creating it adds no compute cost: the workspace starts only when an agent first reads, writes, or runs something in it.

Request

Requires bearer authentication and a JSON body.

Returns 201 Created as application/json. The created workspace.

Response schema: Workspace.

{
  "id": "ws_3Vb8Ny6HpU1cGf4M",
  "tenantId": "ten_8Hq2Zr5WcY1bJt6D",
  "name": "Release files",
  "userId": "user_42",
  "metadata": {
    "project": "docs"
  },
  "networkPolicy": {
    "mode": "allowlist",
    "allowedHosts": [
      "registry.npmjs.org"
    ]
  },
  "createdAt": "2026-07-10T10:00:00.000Z",
  "updatedAt": "2026-07-10T10:00:00.000Z"
}

Errors

See REST errors for the error envelope and shared codes.

cURL

curl --request POST "$BLAZING_AGENTS_BASE_URL/v1/workspaces" \
  --header "Authorization: Bearer $BLAZING_AGENTS_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"name":"Release files","userId":"user_42","metadata":{"project":"docs"},"networkPolicy":{"mode":"allowlist","allowedHosts":["registry.npmjs.org"]}}'

Get workspaceGET/v1/workspaces/:workspaceId

Get a workspace.

Returns a workspace without starting it.

Request

Requires bearer authentication.

Returns 200 OK as application/json. The workspace.

Response schema: Workspace.

{
  "id": "ws_3Vb8Ny6HpU1cGf4M",
  "tenantId": "ten_8Hq2Zr5WcY1bJt6D",
  "name": "Release files",
  "userId": "user_42",
  "metadata": {
    "project": "docs"
  },
  "networkPolicy": {
    "mode": "allowlist",
    "allowedHosts": [
      "registry.npmjs.org"
    ]
  },
  "createdAt": "2026-07-10T10:00:00.000Z",
  "updatedAt": "2026-07-10T10:00:00.000Z"
}

Errors

See REST errors for the error envelope and shared codes.

cURL

curl "$BLAZING_AGENTS_BASE_URL/v1/workspaces/ws_1234567890ABCDEF" \
  --header "Authorization: Bearer $BLAZING_AGENTS_API_KEY"

Update workspacePUT/v1/workspaces/:workspaceId

Update a workspace.

Updates a workspace's name, metadata, or network policy. Send at least one field. metadata and networkPolicy replace their current values, and name: null clears the name. userId cannot be changed. If a new network policy switches between unrestricted and a restricted mode, a running workspace saves its files and stops; it applies the new policy the next time an agent uses it. A concurrent workspace change can return 409 workspace_busy; retry after the active work finishes.

Request

Requires bearer authentication and a JSON body.

Returns 200 OK as application/json. The updated workspace.

Response schema: Workspace.

{
  "id": "ws_3Vb8Ny6HpU1cGf4M",
  "tenantId": "ten_8Hq2Zr5WcY1bJt6D",
  "name": "Release files",
  "userId": "user_42",
  "metadata": {
    "project": "docs"
  },
  "networkPolicy": {
    "mode": "offline"
  },
  "createdAt": "2026-07-10T10:00:00.000Z",
  "updatedAt": "2026-07-10T10:15:00.000Z"
}

Errors

See REST errors for the error envelope and shared codes.

cURL

curl --request PUT "$BLAZING_AGENTS_BASE_URL/v1/workspaces/ws_1234567890ABCDEF" \
  --header "Authorization: Bearer $BLAZING_AGENTS_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"networkPolicy":{"mode":"offline"}}'

Delete workspaceDELETE/v1/workspaces/:workspaceId

Delete a workspace.

Permanently deletes a workspace and all its files. Every agent needs a workspace, so move attached agents to another workspace first: while any agent uses it, the request returns 409 workspace_in_use with their IDs in details.agentIds. Returns 202 while cleanup is still running and 204 when deletion finishes right away.

Request

Requires bearer authentication.

Returns 202 Accepted. Deletion started and is still running.

Returns 204 No Content. The workspace was deleted.

Errors

See REST errors for the error envelope and shared codes.

cURL

curl --request DELETE "$BLAZING_AGENTS_BASE_URL/v1/workspaces/ws_1234567890ABCDEF" \
  --header "Authorization: Bearer $BLAZING_AGENTS_API_KEY"

Next

• Workspaces to share files between agents and sessions.
• Workspace object for every field.