Sign in
projects

Create project

Plan: All plans

Creates a new project. Pass workspace_id in the request body.

post/v1/projects

Request body

OR

Example request

{
  "description": "A landing page for my SaaS product with a hero, features, and pricing.",
  "display_name": "Acme Landing Page",
  "ephemeral_files": [
    {
      "file_id": "Xy7Kd2Lm9Qp4Rt6Vw8Zc1Bn3Fh5/logo.png",
      "file_name": "logo.png",
      "mime_type": "image/png",
      "type": "user_upload"
    }
  ],
  "files": [
    {
      "file_id": "Xy7Kd2Lm9Qp4Rt6Vw8Zc1Bn3Fh5/logo.png",
      "file_name": "logo.png",
      "mime_type": "image/png",
      "type": "user_upload"
    }
  ],
  "headless": true,
  "initial_message": "A landing page for my SaaS product with a hero, features, and pricing.",
  "sandbox_template": "lovable-on-lovable",
  "selected_libraries": [
    {
      "project_id": "prj_01jw3k9m2xq8r5v0c7d4e6f2gh"
    }
  ],
  "tech_stack": "vite",
  "template_project_id": "prj_01jw3k9m2xq8r5v0c7d4e6f2gh",
  "visibility": "private",
  "workspace_id": "workspace_01jw3k9m2xq8r5v0c7d4e6f2gh"
}

Response

OK

descriptionstring

Description supplied by the caller on create or update

display_namestring

Project display name

idstring

Project ID

is_publishedboolean

Whether the project is published

job_idstring

Remix job ID for tracking progress when source_project_id is provided

latest_commit_shastring

SHA of the latest commit

latest_screenshot_urlstring

URL of the latest screenshot

message_idstring

User message ID, present when initial_message was provided

namestring

Project slug

preview_urlstring

Static-preview URL for the project, on the workspace's branded host when it has one. Resolves once the first build completes. Absent on remix creates, which return job_id before the project exists.

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.

urlstring

Published project URL

visibilitystring

Project visibility: draft, private, workspace_view, public

workspace_idstring

Workspace ID

Example response

{
  "description": "A landing page for Acme with a hero, features, and pricing.",
  "display_name": "Acme Landing Page",
  "id": "prj_01jw3k9m2xq8r5v0c7d4e6f2gh",
  "is_published": true,
  "job_id": "job_01jw3k9m2xq8r5v0c7d4e6f2gh",
  "latest_commit_sha": "9f3c2a1b8d4e5f6a7b8c9d0e1f2a3b4c5d6e7f80",
  "latest_screenshot_url": "https://lovable.dev/cdn/projects/acme-landing-page/screenshot.png",
  "message_id": "msg_01jw3k9m2xq8r5v0c7d4e6f2gh",
  "name": "acme-landing-page",
  "preview_url": "https://acme-landing-page.lovable.app/",
  "status": "completed",
  "url": "https://acme-landing-page.lovable.app",
  "visibility": "private",
  "workspace_id": "workspace_01jw3k9m2xq8r5v0c7d4e6f2gh"
}

Changes