---
title: "Create worktree"
method: POST
path: "/api/worktree"
tags: ["worktree"]
---

# Create worktree

`POST /api/worktree`

## Request

- Base URL: `https://opencode.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://opencode.ai/api/worktree`
- Auth: none required

Load the project's canonical configuration, create a local worktree using its selected strategy, then run the project's setup script.

## Request body

- WorktreeCreateInput
  - `projectID` string, required
  - `from` string
  - `branch` string
  - `directory` string
  - `name` string

## Response `200`

Worktree.Info

- WorktreeInfo
  - `directory` string, required

## Other responses

- `400`: WorktreeError | InvalidRequestError
- `401`: UnauthorizedError
- `404`: ProjectNotFoundError

---

[API](https://skmtc.dev/kaaass/apis/opencode.md) - [All operations](https://skmtc.dev/kaaass/apis/opencode/llms.txt) - [OpenAPI document](https://skmtc.dev/kaaass/apis/opencode/revisions/4e083d954707?raw)