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

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

Project status. 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

Changes