Skip to main content
POST
TypeScript SDK

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Project display name.

Required string length: 1 - 120
sizes
enum<string>[]
required

Workspace VM sizes to build for this project.

Minimum array length: 1
Available options:
nano,
micro,
medium,
large,
xl,
xxl,
ultra
description
string | null

Short project description, or null to clear it.

Maximum string length: 300
includeDeps
boolean

Include project dependencies when building the environment. Defaults to true on creation.

includeSkills
boolean

Include skills in the project environment. Defaults to true on creation.

setupScript
string | null

Setup script to run while building the environment, or null to clear it.

Maximum string length: 100000
codeRepositoryIds
string[] | null

Repository IDs included in the project environment. On update, replaces the repository selection.

Required string length: 1 - 255
agentInstructions
string | null

Instructions supplied to agents using this project, or null to clear them.

Maximum string length: 20000
color
enum<string>

Project display color.

Available options:
neutral,
red,
orange,
yellow,
green,
teal,
blue,
purple,
pink
icon
enum<string>

Project display icon.

Available options:
folder,
code,
terminal,
book,
brain,
bug,
building,
cloud,
globe,
idea,
tools,
magic,
processor,
sandbox,
server,
tasks,
tactics,
images,
database,
api,
mobile,
package
onboardingDefault
boolean

Make this project the onboarding default for the organization.

runNow
boolean

Queue initial snapshot builds immediately when a build host is available. Defaults to false.

schedule
object

Recurring schedule for rebuilding the project environment.

Response

Create a project

jobIds
string[]
required
Required string length: 1 - 255
project
object
required