projects

Update Project

Updates the metadata of an existing project using its projectId. Supports changes to the project name and privacy setting.

patch/projects/{projectId}

Path parameters

projectIdstring required

The unique identifier of the project to update. Provided as a path parameter.

namestring

A new name to assign to the project. Helps with identification and organization.

descriptionstring

A new description to assign to the project. Helps with identification and organization.

instructionsstring

Guidance or goals that provide context for the model when working within the project.

privacy'private' | 'team'

The privacy setting for the project. For user accounts, this must be "private". For team/enterprise accounts, this can be either "private" or "team".

Success

idstring required

A unique identifier for the project.

object'project' required

Fixed value identifying this object as a project.

namestring required

The name of the project as defined by the user.

privacy'private' | 'team' required

The privacy setting for the project - either private or team.

vercelProjectIdstring

Optional ID of the linked Vercel project, if connected.

createdAtstring date-time required

The ISO timestamp representing when the project was created.

updatedAtstring date-time

The ISO timestamp of the most recent update, if available.

apiUrlstring uri required

The API endpoint URL for accessing this project programmatically.

webUrlstring uri required

The web URL where the project can be viewed or managed.

descriptionstring

The description of the project.

instructionsstring

The instructions for the project.