---
title: "Open a template project workspace"
method: POST
path: "/v1/templates/{id}/workspace"
tags: ["Templates"]
---

# Open a template project workspace

`POST /v1/templates/{id}/workspace`

## Request

- Base URL: `https://api.samva.dev`
- URL: `https://api.samva.dev/v1/templates/{id}/workspace`
- Auth: API key in header `x-api-key`

Creates or opens the shared project workspace at the latest saved version and returns its effective files.

## Path parameters

- `id` string, required

## Response `200`

Success

- object
  - `workspace` object, required
    - `projectId` string, required
    - `organizationId` string, required
    - `ownerEpoch` integer, required
    - `repositoryName` string, required
    - `defaultBranch` string, required
    - `baseCommit` string, required
    - `remoteHead` string, required
    - `pendingRemoteHead` string, nullable, required
    - `revision` string, required
    - `overlay` object, required
    - `assetChanges` object[], required
      - `path` string, required
      - `status` 'added' | 'modified' | 'deleted', required
    - `conflicts` object[], required
      - `path` string, required
      - `base` string, nullable, required
      - `draft` string, nullable, required
      - `main` string, nullable, required
    - `provenance` object, required
      - `references` object[], required
        - `kind` string, required
        - `digest` string, required
        - `locator` string
    - `mounts` union[], required
      - union
        - object
          - `kind` 'project', required
          - `root` '/project', required
          - `access` 'read-write', required
        - object
          - `root` string, required
          - `digest` string, required
          - `fileCount` integer, required
          - `byteSize` integer, required
          - `kind` 'started-from', required
          - `access` 'read-only', required
          - `templateId` string, required
          - `slug` string, required
          - `name` string, required
        - object
          - `root` string, required
          - `digest` string, required
          - `fileCount` integer, required
          - `byteSize` integer, required
          - `kind` 'resource', required
          - `access` 'read-only', required
          - `resourceId` string, required
          - `name` string, required
        - object
          - `root` string, required
          - `digest` string, required
          - `fileCount` integer, required
          - `byteSize` integer, required
          - `kind` 'library-template', required
          - `access` 'read-only', required
          - `templateId` string, required
          - `slug` string, required
          - `name` string, required
    - `libraryManifestDigest` string, required
    - `createdAt` string, required
    - `updatedAt` string, required
    - `createdBy` object, required
      - `userId` string, required
      - `via` 'api' | 'mcp' | 'agent', required
    - `updatedBy` object, required
      - `userId` string, required
      - `via` 'api' | 'mcp' | 'agent', required
  - `files` object, required

## Other responses

- `401`: UnauthorizedError
- `403`: ForbiddenError
- `404`: ResourceNotFoundError
- `409`: ConflictError
- `422`: ValidationError
- `500`: InternalError
- `504`: GatewayTimeoutError

---

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