Skip to main content
POST
Create project

Authorizations

Authorization
string
header
required

JWT authentication token

Body

application/json
id
string<uuid>

Deprecated and ignored. The server always generates the project UUID and returns it in the response.

name
string

Optional. Project name. If omitted or empty the server stores an empty name and may generate one asynchronously from the first task. A non-empty name must be 2 to 128 characters after surrounding whitespace is collapsed. Length counts characters, so an accented letter like "é" counts as one.

Maximum string length: 128
settings_md
string

Optional initial project settings markdown. Values longer than 35k characters are truncated by the API and suffixed with "[truncated] max char limit 35k".

tags
string[]

Optional. Initial tags. Capped at 20. The agent merges additional tags onto this set asynchronously.

type
enum<string>
default:shared

Optional. Workspace type, fixed at creation and cannot be changed later. 'shared' (default) runs in the common team workspace and is shared with the whole team. 'dedicated' uses an isolated, private workspace accessible only to invited members.

Available options:
shared,
dedicated

Response

Project created

project
object
required