---
title: "Join Workspace"
method: POST
path: "/api/workspaces/join"
tags: ["workspaces"]
---

# Join Workspace

`POST /api/workspaces/join`

## Request body

- JoinWorkspaceRequest
  - `secret` string, required

## Response `200`

Successful Response

- QuadrillionCloudApiRoutersWorkspacesWorkspaceResponse
  - `workspace_id` string, required
  - `name` string, nullable, required
  - `created_at` string, required
  - `size_bytes` integer, nullable, required
  - `size_file_count` integer, nullable, required
  - `size_measured_at` string, nullable, required
  - `role` string, required
  - `shared_by` string, nullable, required
  - `is_shared_by_me` boolean, required
  - `is_default` boolean, required
  - `preview` WorkspacePreview, required
    - `version` 1
    - `accent` 'blue' | 'violet' | 'emerald' | 'amber' | 'rose' | 'teal', required
    - `surface` union, required
      - NotebookSurface
        - `surface` 'notebook', required
        - `notebook` string, required
        - `cell` NotebookCell, required
          - `lines` LineText[], required
        - `figure` PreviewFigure, required
          - `blob_id` string, required
          - `title` string, required
      - ProjectSurface
        - `surface` 'project', required
        - `notebook` string, required
        - `task` PreviewTask, required
          - `title` string, required
          - `description` string, required
          - `status` 'planned' | 'in_progress' | 'completed' | 'failed' | 'cancelled' | 'paused_by_user', required — Possible statuses for a task in the DAG.
          - `result` string, required
      - KnowledgeSurface
        - `surface` 'knowledge', required
        - `pending` integer, required
        - `claims` PreviewClaim[], required
          - `title` string, required
          - `statement` string, required
      - ChatSurface
        - `surface` 'chat', required
        - `agent` string, required
        - `role` 'user' | 'agent', required
        - `text` string, required
        - `tasks_completed` integer, required
        - `tasks_total` integer, required
      - ShellSurface
        - `surface` 'shell', required
        - `files` PreviewFile[], required
          - `name` string, required
          - `kind` 'folder' | 'notebook', required
          - `nested` boolean, required
        - `agent` PreviewAgent, required
          - `name` string, required
          - `task` string, required
          - `done` boolean, required
        - `notebook` string, required
        - `cells` NotebookCell[], required
          - `lines` LineText[], required
  - `preview_generated_at` string, nullable, required

## Other responses

- `422` — Validation Error

## Changes

- **2026-09-23** `d7f2f3b8e82d` — 2 info
  - added the required property `preview` to the response with the `200` status
  - added the required property `preview_generated_at` to the response with the `200` status
- **2026-09-18** `abf76937a751` — 2 info
  - added the optional property `detail/items/ctx` to the response with the `422` status
  - added the optional property `detail/items/input` to the response with the `422` status
- **2026-09-10** `3a8d4a28ae93` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/quadrillion/apis/quadrillion-cloud-api/changes/api/workspaces/join/post.md)

---

[API](https://skmtc.dev/quadrillion/apis/quadrillion-cloud-api.md) · [All operations](https://skmtc.dev/quadrillion/apis/quadrillion-cloud-api/llms.txt) · [OpenAPI document](https://skmtc.dev/quadrillion/apis/quadrillion-cloud-api/revisions/d61e2ec5a271?raw)