Sign in
projects

Update project

Plan: All plans

Updates supported project fields such as visibility and display_name.

patch/v1/projects/{project_id}

Path parameters

project_idstring required

Project ID

Project ID

Request body

descriptionstring

Project description. Does not affect generated_description, which the agent maintains on its own.

display_namestring

Project display name

visibility'draft' | 'private' | 'public' | 'workspace_view'

Project visibility

Response

OK

created_atstring date-time

When the project was created.

descriptionstring

Description supplied by the caller on create or update.

display_namestring

Human-readable project name.

folder_idstring

Folder the project belongs to, if any.

generated_descriptionstring

AI-written summary of what the project does. Absent until the agent has completed a response for the project.

idstring required

Project ID.

is_publishedboolean

Whether the project is published.

last_edited_atstring date-time

When the project was last edited.

latest_commit_shastring

SHA of the latest commit

latest_screenshot_urlstring

URL of the latest screenshot.

namestring

Project slug.

og_image_urlstring

Open Graph image URL.

preview_urlstring

Static-preview URL for the project, on the workspace's branded host when it has one. Resolves once the first build completes. Opening it requires a Lovable login unless the project is publicly remixable; to frame it from a third-party origin without one, mint an origin-bound token via POST /v1/projects/{project_id}/embed-url.

project_typestring

Project type. One of: project, library. Absent on older projects. More values may be added; clients must tolerate unknown values.

publish_visibilitystring

Published visibility. One of: public, private. More values may be added; clients must tolerate unknown values.

statusstring

Project status. One of: in_progress, completed, failed. More values may be added; clients must tolerate unknown values.

tech_stackstring

Project tech stack.

updated_atstring date-time

When the project was last updated.

urlstring

Published project URL.

user_idstring

Project owner user ID.

visibilitystring

Project visibility: draft, private, workspace_view, or public.

workspace_idstring required

Workspace the project belongs to.

Changes