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

Example request

{
  "description": "A landing page for my SaaS product with a hero, features, and pricing.",
  "display_name": "Acme Landing Page",
  "visibility": "private"
}

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

Provisioning status of the project, not agent build progress. 'completed' means the project scaffold was created, and is set before the agent has finished the initial message, so the code at that point is often an empty starter page. To check whether the agent finished building, poll GET /v1/messages/{message_id}. 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.

Example response

{
  "created_at": "2026-01-15T09:30:00Z",
  "description": "Marketing landing page for Acme's product launch.",
  "display_name": "Acme Landing Page",
  "folder_id": "fold_01jw3k9m2xq8r5v0c7d4e6f2gh",
  "generated_description": "A landing page for Acme with a hero, features, and pricing.",
  "id": "prj_01jw3k9m2xq8r5v0c7d4e6f2gh",
  "is_published": true,
  "last_edited_at": "2026-01-15T09:30:00Z",
  "latest_commit_sha": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0",
  "latest_screenshot_url": "https://screenshot2.lovable.dev/acme-landing-page.png",
  "name": "acme-landing-page",
  "og_image_url": "https://lovable.dev/cdn/projects/acme-landing-page/og.png",
  "preview_url": "https://acme-landing-page.lovable.app/",
  "project_type": "project",
  "publish_visibility": "public",
  "status": "completed",
  "tech_stack": "vite_react_shadcn_ts",
  "updated_at": "2026-01-15T09:30:00Z",
  "url": "https://acme-landing-page.lovable.app",
  "user_id": "Xy7Kd2Lm9Qp4Rt6Vw8Zc1Bn3Fh5",
  "visibility": "public",
  "workspace_id": "workspace_01jw3k9m2xq8r5v0c7d4e6f2gh"
}

Changes