Get Workspace

Get a workspace by ID

Returns a single workspace by its ID.

Authentication

Requires a valid Bearer token.

Path Parameters

id · string · required

Workspace ID (UUID).

Response

Returns the full workspace object. See List All Workspaces for the complete schema.

200

{
  "id": "b2c3d4e5-6789-01ab-cdef-234567890abc",
  "project_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "status": "running",
  "hardware": {
    "cpu_kind": "shared",
    "cpus": 2,
    "memory_mb": 2048,
    "volume_size_gb": 10,
    "gpu_kind": null
  },
  "keep_active": false,
  "machine_id": "d8901234abcd",
  "private_ip": "10.0.0.2",
  "git_ref": "main",
  "preview_token": "ptk_abc123",
  "error_message": null,
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-15T11:00:00Z"
}

Errors

Status	Description
401	Unauthorized — missing or invalid token
404	Not Found — workspace does not exist or you do not have access