Skip to main content
POST
Create a project

Authorizations

Authorization
string
header
required

Body

application/json
name
string
required

The name of the new project.

Minimum string length: 1
folderId
string

The developer ID of the folder to create the project in. If omitted, the project is created at the workspace root.

baseId
string

The Developer ID of the base to connect the new project to. If omitted, the project will not be connected to a base.

githubBranch
string

The GitHub branch to pair the new project with. Requires baseId.

Minimum string length: 1

Response

200 - application/json

Returns the developer ID and name of the created project, as well as the developer ID of the connected base (or null).

id
string
required

The Developer ID of the project

name
string
required

The name of the project

url
string
required

The URL of the project in the Ditto web app

baseId
string | null
required

The Developer ID of the base the project is connected to, or null if not connected to a base

githubBranch
string | null
required

The GitHub branch the project is paired with, or null if it isn't paired with a branch

pullRequest
object | null
required

The open pull request for the project's branch, or null if there isn't one

branchImportStatus
enum<string> | null
required

The status of importing the paired branch's changes into the project: preparing while it runs in the background, then ready or failed. Null if no branch has been imported.

Available options:
preparing,
ready,
failed,
null