Projects

Manage projects and files. Manage embeddings for vector search, or query project knowledge metadata. Select a branch, environment, or release when the endpoint supports multiple content versions. Review and merge source changes. Inspect files by branch, environment, or release, and manage the project’s dependencies and generated CSS artifacts. Run commands synchronously, stream their output, or start background commands. Use the sandbox ID to access files, command results, and the terminal. Use the file endpoints and terminal endpoint to work in the same sandbox. Health, readiness, and heartbeat endpoints support sandbox monitoring. See WebSocket connections for terminal WebSocket access. Projects · Files · Branches · Uploads

List, create, read, update, or delete projects. List, create, update, or delete project labels. List or create projects assigned to an account. List or search project templates, the starter projects a new project is created from. /templates and /templates/find are the deprecated aliases of /project-templates and /project-templates/search. List, add, or remove favorite projects for the current user. Favorites do not grant project access.

Endpoint	Methods	Description
`/favorites/{project_reference}`	GET, POST, DELETE	Check project favorite; Add project to favorites; Remove project from favorites
`/favorites`	GET	List favorite projects
`/accounts/{account_id}/projects`	GET, POST	List account projects; Create account project
`/projects`	GET, POST	List projects; Create project
`/projects/{project_reference}`	GET, PATCH, DELETE	Get project; Update project; Delete project
`/projects/lookup-names`	POST	Look up project names
`/projects/{project_reference}/labels`	GET, POST	List project labels; Create project label
`/projects/{project_reference}/labels/{label_id}`	PUT, DELETE	Update project label; Delete project label
`/project-templates`	GET	List project templates
`/project-templates/search`	POST	Search project templates
`/templates`	GET (deprecated)	List templates (legacy)
`/templates/find`	POST (deprecated)	Search templates (legacy)

Files

Read file chunks used for indexing. Create or delete chunks on a branch, or read chunks from a branch, environment, or release. List, read, write, move, delete, diff, or batch-read project files. List or read saved project file versions. Search project or branch files by text. Use the Knowledge API for vector search. Read branch files and diffs. List or read saved branch file versions. Read, replace, or discard pending file drafts. Read files and diffs from a named environment. Manage environment settings through Environments. Read files and diffs from a specific release. List, read, or write sandbox files.

Endpoint	Methods	Description
`/projects/{project_reference}/files/{file_path}`	GET, PUT, DELETE	Get file; Upsert file; Delete file
`/projects/{project_reference}/files`	GET	List files
`/projects/{project_reference}/files/batch`	POST	Batch get files
`/projects/{project_reference}/files/{file_path}/diff`	GET	Get file diff
`/projects/{project_reference}/files/move`	POST	Move file
`/projects/{project_reference}/branches/{branchName}/files/{filePath}/chunks`	GET, POST, DELETE	List branch file chunks; Upsert branch file chunks; Delete branch file chunks
`/projects/{project_reference}/chunks`	GET	List chunks
`/projects/{project_reference}/environments/{environmentName}/files/{filePath}/chunks`	GET	List environment file chunks
`/projects/{project_reference}/releases/{version}/files/{filePath}/chunks`	GET	List release file chunks
`/projects/{project_reference}/branches/{branchName}/files/{filePath}/chunks/{chunkId}`	GET	Get branch file chunk
`/projects/{project_reference}/environments/{environmentName}/files/{filePath}/chunks/{chunkId}`	GET	Get environment file chunk
`/projects/{project_reference}/releases/{version}/files/{filePath}/chunks/{chunkId}`	GET	Get release file chunk
`/projects/{project_reference}/branches/{branchName}/files/{filePath}/versions`	GET	List branch file versions
`/projects/{project_reference}/branches/{branchName}/files/{filePath}/versions/{version_id}`	GET	Get branch file version
`/projects/{project_reference}/branches/{branchName}/files`	GET	List branch files
`/projects/{project_reference}/branches/{branchName}/files/{filePath}`	GET	Get branch file
`/projects/{project_reference}/branches/{branchName}/files/{filePath}/diff`	GET	Get branch file diff
`/projects/{project_reference}/environments/{environmentName}/files`	GET	List environment files
`/projects/{project_reference}/environments/{environmentName}/files/{filePath}`	GET	Get environment file
`/projects/{project_reference}/environments/{environmentName}/files/{filePath}/diff`	GET	Get environment file diff
`/projects/{project_reference}/files/{file_path}/versions`	GET	List file versions
`/projects/{project_reference}/files/{file_path}/versions/{version_id}`	GET	Get file version
`/projects/{project_reference}/drafts`	GET	List pending file drafts
`/projects/{project_reference}/branches/{branchName}/files/{filePath}/draft`	GET, PUT, DELETE	Get branch file draft; Replace pending file draft; Delete branch file draft
`/projects/{project_reference}/releases/{version}/files`	GET	List release files
`/projects/{project_reference}/releases/{version}/files/{filePath}`	GET	Get release file
`/projects/{project_reference}/releases/{version}/files/{filePath}/diff`	GET	Get release file diff
`/sandboxes/{sandbox_id}/files`	GET, POST	List sandbox files; Write sandbox files
`/sandboxes/{sandbox_id}/file`	GET	Read sandbox file
`/projects/{project_reference}/branches/{branchName}/files/search`	POST	Search branch files (text)
`/projects/{project_reference}/files/search`	POST	Search files (text)

Branches

Create, read, delete, preview, check, or merge branches. List, create, or dismiss branch approvals. List or report branch status checks. List, create, or delete branch policies. Commit project file changes.

Endpoint	Methods	Description
`/projects/{project_reference}/branches`	GET, POST	List branches; Create branch
`/projects/{project_reference}/branches/{branch_id}`	GET, DELETE	Get branch; Delete branch
`/projects/{project_reference}/branches/{branchId}/eligibility`	GET (deprecated)	Check branch eligibility
`/projects/{project_reference}/branches/{branch_id}/merge`	POST	Merge branch
`/projects/{project_reference}/branch-policies`	GET, POST	List branch policies; Create branch policy
`/projects/{project_reference}/branch-policies/{policy_id}`	DELETE	Delete branch policy
`/projects/{project_reference}/policies`	GET (deprecated), POST (deprecated)	List branch policies (legacy path); Create branch policy (legacy path)
`/projects/{project_reference}/policies/{policyId}`	DELETE (deprecated)	Delete branch policy (legacy path)
`/projects/{project_reference}/branches/{branch_id}/approvals`	GET, POST	List branch approvals; Create branch approval
`/projects/{project_reference}/branches/{branchId}/approve`	POST (deprecated)	Approve branch
`/projects/{project_reference}/branches/{branch_id}/approvals/{approval_id}/dismiss`	POST	Dismiss branch approval
`/projects/{project_reference}/branches/{branchId}/approvals/{approvalId}`	DELETE (deprecated)	Dismiss branch approval (legacy method)
`/projects/{project_reference}/branches/{branch_id}/status-checks`	GET	List branch status checks
`/projects/{project_reference}/branches/{branch_id}/status-checks/{check_name}`	PUT	Update branch status check
`/projects/{project_reference}/branches/{branchId}/status-checks`	POST (deprecated)	Upsert branch status check
`/projects/{project_reference}/commit`	POST	Commit files
`/projects/{project_reference}/branches/{branch_id}/merge-preview`	GET	Get branch merge preview
`/projects/{project_reference}/branches/{branch_id}/merge-eligibility`	GET	Check branch merge eligibility

Uploads

List, upload, read, move, restore, delete, or get download URLs for uploads. Create, rename, or delete upload folders. List, set, or revoke upload grants. Set or remove upload path visibility.

Endpoint	Methods	Description
`/projects/{project_reference}/uploads/folders`	POST	Create folder
`/projects/{project_reference}/uploads/folders/{path}`	DELETE	Delete folder
`/projects/{project_reference}/uploads/folders/{path}/rename`	POST	Rename folder
`/projects/{project_reference}/uploads/grants/{path}`	GET, PUT	List grants; Set grants
`/projects/{project_reference}/uploads/grants/{path}/{user_id}`	DELETE	Revoke grant
`/projects/{project_reference}/uploads`	GET, POST	List uploads; Upload file
`/projects/{project_reference}/uploads/{upload_reference}`	GET, DELETE	Get upload; Delete upload
`/projects/{project_reference}/uploads/{upload_reference}/url`	GET	Get upload download URL
`/projects/{project_reference}/uploads/download-urls`	POST	Get upload download URLs
`/projects/{project_reference}/uploads/{upload_reference}/move`	POST	Move upload
`/projects/{project_reference}/uploads/{upload_reference}/restore`	POST	Restore upload
`/projects/{project_reference}/uploads/visibility/{path}`	PUT, DELETE	Set path visibility; Delete path visibility

Back to REST API reference

Get started

APIs

REST API

GraphQL API

MCP API

Projects

Projects

Files

Branches

Uploads

​Projects

​Files

​Branches

​Uploads

Projects

Files

Branches

Uploads