Skip to main content
PATCH
TypeScript SDK

Authorizations

Authorization
string
header
required

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

Path Parameters

projectId
string
required
Required string length: 1 - 255

Body

application/json
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.

name
string

Project display name.

Required string length: 1 - 120
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
defaultForSizes
enum<string>[]

VM sizes for which this project is the organization default. An empty array removes its default assignments.

Available options:
nano,
micro,
medium,
large,
xl,
xxl,
ultra
environmentVariables
object

Replace the complete environment-variable map. Use createProjectEnvironmentVariables to add or replace individual keys instead.

schedule
object

Change the project build schedule, including enabling or pausing it.

sizes
enum<string>[]

Replace the workspace VM sizes built for this project.

Minimum array length: 1
Available options:
nano,
micro,
medium,
large,
xl,
xxl,
ultra
warmPoolEnabled
boolean

Enable or disable prewarmed VMs for this project.

Response

Update a project

createdAt
string<date-time>
required
description
string | null
required
id
string
required
Required string length: 1 - 255
includeDeps
boolean
default:true
required
includeSkills
boolean
default:true
required
name
string
required
setupScript
string | null
required
updatedAt
string<date-time>
required
activeSnapshots
object[]
required
agentInstructions
string | null
required
Maximum string length: 20000
codeRepositoryIds
string[] | null
required
Required string length: 1 - 255
color
enum<string>
required
Available options:
neutral,
red,
orange,
yellow,
green,
teal,
blue,
purple,
pink
defaultForSizes
enum<string>[]
required
Available options:
nano,
micro,
small,
medium,
large,
xl,
xxl,
ultra
icon
enum<string>
required
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
required

True for the project created during onboarding until it is first edited

sizes
enum<string>[]
required
Available options:
nano,
micro,
medium,
large,
xl,
xxl,
ultra
warmPoolEnabled
boolean
required