---
title: "Open a short-lived project preparation workspace"
method: POST
path: "/v1/project-templates/prepare"
tags: ["Project templates"]
---

# Open a short-lived project preparation workspace

`POST /v1/project-templates/prepare`

## Request

- Base URL: `https://api.shardflux.dev`
- URL: `https://api.shardflux.dev/v1/project-templates/prepare`
- Auth: HTTP bearer

## Request body

- object
  - `repo_remote` string, required
  - `deps_hash` string, required
  - `worktree_id` string, required
  - `project_id` string, uuid: UUIDv7, lowercase canonical form.

## Response `202`

Default Response

- object
  - `workspace_id` string, uuid, required: UUIDv7, lowercase canonical form.
  - `workspace_key` string, required
  - `deps_hash` string, required
  - `setup_required` boolean, required

## Other responses

- `4XX`: Default Response
- `5XX`: Default Response

---

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