Skip to main content
POST
/
projects
Create project
curl --request POST \
  --url https://api.specular.dev/projects/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "git": {
    "remoteUrl": "<string>",
    "initialBranch": "<string>",
    "username": "<string>",
    "password": "<string>",
    "mainBranch": "<string>",
    "path": "<string>"
  }
}
'
{
  "project": {
    "id": "<string>",
    "name": "<string>",
    "state": "creating",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "git": {
      "remoteUrl": "<string>",
      "username": "<string>",
      "mainBranch": "<string>",
      "path": "<string>"
    }
  },
  "branch": {
    "id": "<string>",
    "projectId": "<string>",
    "name": "<string>",
    "state": "idle",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "mcpUrl": "<string>",
    "appUrl": "<string>",
    "openApiSpec": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication with API key (format: Bearer sk_xxx)

Body

application/json
name
string
required

Project name

git
object

Optional custom Git repository configuration

Response

Project created successfully

Project created successfully

project
object
branch
object