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
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
includeDeps
boolean

Deprecated and ignored. Project builds always install dependencies.

includeSkills
boolean

Deprecated and ignored. Project builds always include skills.

resourceSettings
object
defaultForSizes
enum<string>[]

Make this project the organization default with any size, or remove its default with an empty array. Sizes are otherwise ignored.

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>[]

Deprecated and ignored. Projects always use automatic sizing.

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

Weekly availability for prewarmed VMs. Null means always on; days use 0=Sunday. Overnight windows end the following day.

warmPoolEnabled
boolean

Enable or disable prewarmed VMs for this project.

Response

Update a project

createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
description
string | null
required
id
string
required
Required string length: 1 - 255
name
string
required
setupScript
string | null
required
updatedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
activeSnapshots
object[]
required
resourceSettings
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
warmPoolSchedule
object | null
required