> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Projects

> Manage projects and files.

Manage projects and files.

Manage [embeddings](/docs/cloud/rest/apis/knowledge#embeddings) for [vector search](/docs/cloud/rest/apis/knowledge#search), or query [project knowledge metadata](/docs/cloud/rest/apis/knowledge#documents). 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](/docs/cloud/rest/api-reference/projects-files-sandbox-files/list-sandbox-files) and [terminal endpoint](/docs/cloud/rest/api-reference/runtime-sandboxes-sandbox-terminal/open-sandbox-terminal) to work in the same sandbox. Health, readiness, and heartbeat endpoints support sandbox monitoring. See [WebSocket connections](https://veryfront.com/docs/cloud/rest/protocols#websocket-connections) for terminal WebSocket access.

[Projects](#projects) · [Files](#files) · [Branches](#branches) · [Uploads](#uploads)

## Projects

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](/docs/cloud/rest/api-reference/projects-projects-favorites/check-project-favorite), [POST](/docs/cloud/rest/api-reference/projects-projects-favorites/add-project-to-favorites), [DELETE](/docs/cloud/rest/api-reference/projects-projects-favorites/remove-project-from-favorites) | Check project favorite; Add project to favorites; Remove project from favorites |
| `/favorites` | [GET](/docs/cloud/rest/api-reference/projects-projects-favorites/list-favorite-projects) | List favorite projects |
| `/accounts/{account_id}/projects` | [GET](/docs/cloud/rest/api-reference/projects-projects-account-projects/list-account-projects), [POST](/docs/cloud/rest/api-reference/projects-projects-account-projects/create-account-project) | List account projects; Create account project |
| `/projects` | [GET](/docs/cloud/rest/api-reference/projects-projects-projects/list-projects), [POST](/docs/cloud/rest/api-reference/projects-projects-projects/create-project) | List projects; Create project |
| `/projects/{project_reference}` | [GET](/docs/cloud/rest/api-reference/projects-projects-projects/get-project), [PATCH](/docs/cloud/rest/api-reference/projects-projects-projects/update-project), [DELETE](/docs/cloud/rest/api-reference/projects-projects-projects/delete-project) | Get project; Update project; Delete project |
| `/projects/lookup-names` | [POST](/docs/cloud/rest/api-reference/projects-projects-projects/look-up-project-names) | Look up project names |
| `/projects/{project_reference}/labels` | [GET](/docs/cloud/rest/api-reference/projects-projects-project-labels/list-project-labels), [POST](/docs/cloud/rest/api-reference/projects-projects-project-labels/create-project-label) | List project labels; Create project label |
| `/projects/{project_reference}/labels/{label_id}` | [PUT](/docs/cloud/rest/api-reference/projects-projects-project-labels/update-project-label), [DELETE](/docs/cloud/rest/api-reference/projects-projects-project-labels/delete-project-label) | Update project label; Delete project label |
| `/project-templates` | [GET](/docs/cloud/rest/api-reference/projects-projects-project-templates/list-project-templates) | List project templates |
| `/project-templates/search` | [POST](/docs/cloud/rest/api-reference/projects-projects-project-templates/search-project-templates) | Search project templates |
| `/templates` | [GET](/docs/cloud/rest/api-reference/projects-projects-project-templates/list-templates-legacy) (deprecated) | List templates (legacy) |
| `/templates/find` | [POST](/docs/cloud/rest/api-reference/projects-projects-project-templates/search-templates-legacy) (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](/docs/cloud/rest/apis/knowledge#search) 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](/docs/cloud/rest/apis/runtime#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](/docs/cloud/rest/api-reference/projects-files-files/get-file), [PUT](/docs/cloud/rest/api-reference/projects-files-files/upsert-file), [DELETE](/docs/cloud/rest/api-reference/projects-files-files/delete-file) | Get file; Upsert file; Delete file |
| `/projects/{project_reference}/files` | [GET](/docs/cloud/rest/api-reference/projects-files-files/list-files) | List files |
| `/projects/{project_reference}/files/batch` | [POST](/docs/cloud/rest/api-reference/projects-files-files/batch-get-files) | Batch get files |
| `/projects/{project_reference}/files/{file_path}/diff` | [GET](/docs/cloud/rest/api-reference/projects-files-files/get-file-diff) | Get file diff |
| `/projects/{project_reference}/files/move` | [POST](/docs/cloud/rest/api-reference/projects-files-files/move-file) | Move file |
| `/projects/{project_reference}/branches/{branchName}/files/{filePath}/chunks` | [GET](/docs/cloud/rest/api-reference/projects-files-file-chunks/list-branch-file-chunks), [POST](/docs/cloud/rest/api-reference/projects-files-file-chunks/upsert-branch-file-chunks), [DELETE](/docs/cloud/rest/api-reference/projects-files-file-chunks/delete-branch-file-chunks) | List branch file chunks; Upsert branch file chunks; Delete branch file chunks |
| `/projects/{project_reference}/chunks` | [GET](/docs/cloud/rest/api-reference/projects-files-file-chunks/list-chunks) | List chunks |
| `/projects/{project_reference}/environments/{environmentName}/files/{filePath}/chunks` | [GET](/docs/cloud/rest/api-reference/projects-files-file-chunks/list-environment-file-chunks) | List environment file chunks |
| `/projects/{project_reference}/releases/{version}/files/{filePath}/chunks` | [GET](/docs/cloud/rest/api-reference/projects-files-file-chunks/list-release-file-chunks) | List release file chunks |
| `/projects/{project_reference}/branches/{branchName}/files/{filePath}/chunks/{chunkId}` | [GET](/docs/cloud/rest/api-reference/projects-files-file-chunks/get-branch-file-chunk) | Get branch file chunk |
| `/projects/{project_reference}/environments/{environmentName}/files/{filePath}/chunks/{chunkId}` | [GET](/docs/cloud/rest/api-reference/projects-files-file-chunks/get-environment-file-chunk) | Get environment file chunk |
| `/projects/{project_reference}/releases/{version}/files/{filePath}/chunks/{chunkId}` | [GET](/docs/cloud/rest/api-reference/projects-files-file-chunks/get-release-file-chunk) | Get release file chunk |
| `/projects/{project_reference}/branches/{branchName}/files/{filePath}/versions` | [GET](/docs/cloud/rest/api-reference/projects-files-branch-file-versions/list-branch-file-versions) | List branch file versions |
| `/projects/{project_reference}/branches/{branchName}/files/{filePath}/versions/{version_id}` | [GET](/docs/cloud/rest/api-reference/projects-files-branch-file-versions/get-branch-file-version) | Get branch file version |
| `/projects/{project_reference}/branches/{branchName}/files` | [GET](/docs/cloud/rest/api-reference/projects-files-branch-files/list-branch-files) | List branch files |
| `/projects/{project_reference}/branches/{branchName}/files/{filePath}` | [GET](/docs/cloud/rest/api-reference/projects-files-branch-files/get-branch-file) | Get branch file |
| `/projects/{project_reference}/branches/{branchName}/files/{filePath}/diff` | [GET](/docs/cloud/rest/api-reference/projects-files-branch-files/get-branch-file-diff) | Get branch file diff |
| `/projects/{project_reference}/environments/{environmentName}/files` | [GET](/docs/cloud/rest/api-reference/projects-files-environment-files/list-environment-files) | List environment files |
| `/projects/{project_reference}/environments/{environmentName}/files/{filePath}` | [GET](/docs/cloud/rest/api-reference/projects-files-environment-files/get-environment-file) | Get environment file |
| `/projects/{project_reference}/environments/{environmentName}/files/{filePath}/diff` | [GET](/docs/cloud/rest/api-reference/projects-files-environment-files/get-environment-file-diff) | Get environment file diff |
| `/projects/{project_reference}/files/{file_path}/versions` | [GET](/docs/cloud/rest/api-reference/projects-files-file-versions/list-file-versions) | List file versions |
| `/projects/{project_reference}/files/{file_path}/versions/{version_id}` | [GET](/docs/cloud/rest/api-reference/projects-files-file-versions/get-file-version) | Get file version |
| `/projects/{project_reference}/drafts` | [GET](/docs/cloud/rest/api-reference/projects-files-branch-file-drafts/list-pending-file-drafts) | List pending file drafts |
| `/projects/{project_reference}/branches/{branchName}/files/{filePath}/draft` | [GET](/docs/cloud/rest/api-reference/projects-files-branch-file-drafts/get-branch-file-draft), [PUT](/docs/cloud/rest/api-reference/projects-files-branch-file-drafts/replace-pending-file-draft), [DELETE](/docs/cloud/rest/api-reference/projects-files-branch-file-drafts/delete-branch-file-draft) | Get branch file draft; Replace pending file draft; Delete branch file draft |
| `/projects/{project_reference}/releases/{version}/files` | [GET](/docs/cloud/rest/api-reference/projects-files-release-files/list-release-files) | List release files |
| `/projects/{project_reference}/releases/{version}/files/{filePath}` | [GET](/docs/cloud/rest/api-reference/projects-files-release-files/get-release-file) | Get release file |
| `/projects/{project_reference}/releases/{version}/files/{filePath}/diff` | [GET](/docs/cloud/rest/api-reference/projects-files-release-files/get-release-file-diff) | Get release file diff |
| `/sandboxes/{sandbox_id}/files` | [GET](/docs/cloud/rest/api-reference/projects-files-sandbox-files/list-sandbox-files), [POST](/docs/cloud/rest/api-reference/projects-files-sandbox-files/write-sandbox-files) | List sandbox files; Write sandbox files |
| `/sandboxes/{sandbox_id}/file` | [GET](/docs/cloud/rest/api-reference/projects-files-sandbox-files/read-sandbox-file) | Read sandbox file |
| `/projects/{project_reference}/branches/{branchName}/files/search` | [POST](/docs/cloud/rest/api-reference/projects-files-file-search/search-branch-files-text) | Search branch files (text) |
| `/projects/{project_reference}/files/search` | [POST](/docs/cloud/rest/api-reference/projects-files-file-search/search-files-text) | 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](/docs/cloud/rest/api-reference/projects-branches-branches/list-branches), [POST](/docs/cloud/rest/api-reference/projects-branches-branches/create-branch) | List branches; Create branch |
| `/projects/{project_reference}/branches/{branch_id}` | [GET](/docs/cloud/rest/api-reference/projects-branches-branches/get-branch), [DELETE](/docs/cloud/rest/api-reference/projects-branches-branches/delete-branch) | Get branch; Delete branch |
| `/projects/{project_reference}/branches/{branchId}/eligibility` | [GET](/docs/cloud/rest/api-reference/projects-branches-branches/check-branch-eligibility) (deprecated) | Check branch eligibility |
| `/projects/{project_reference}/branches/{branch_id}/merge` | [POST](/docs/cloud/rest/api-reference/projects-branches-branches/merge-branch) | Merge branch |
| `/projects/{project_reference}/branch-policies` | [GET](/docs/cloud/rest/api-reference/projects-branches-branch-policies/list-branch-policies), [POST](/docs/cloud/rest/api-reference/projects-branches-branch-policies/create-branch-policy) | List branch policies; Create branch policy |
| `/projects/{project_reference}/branch-policies/{policy_id}` | [DELETE](/docs/cloud/rest/api-reference/projects-branches-branch-policies/delete-branch-policy) | Delete branch policy |
| `/projects/{project_reference}/policies` | [GET](/docs/cloud/rest/api-reference/projects-branches-branch-policies/list-branch-policies-legacy-path) (deprecated), [POST](/docs/cloud/rest/api-reference/projects-branches-branch-policies/create-branch-policy-legacy-path) (deprecated) | List branch policies (legacy path); Create branch policy (legacy path) |
| `/projects/{project_reference}/policies/{policyId}` | [DELETE](/docs/cloud/rest/api-reference/projects-branches-branch-policies/delete-branch-policy-legacy-path) (deprecated) | Delete branch policy (legacy path) |
| `/projects/{project_reference}/branches/{branch_id}/approvals` | [GET](/docs/cloud/rest/api-reference/projects-branches-branch-approvals/list-branch-approvals), [POST](/docs/cloud/rest/api-reference/projects-branches-branch-approvals/create-branch-approval) | List branch approvals; Create branch approval |
| `/projects/{project_reference}/branches/{branchId}/approve` | [POST](/docs/cloud/rest/api-reference/projects-branches-branch-approvals/approve-branch) (deprecated) | Approve branch |
| `/projects/{project_reference}/branches/{branch_id}/approvals/{approval_id}/dismiss` | [POST](/docs/cloud/rest/api-reference/projects-branches-branch-approvals/dismiss-branch-approval) | Dismiss branch approval |
| `/projects/{project_reference}/branches/{branchId}/approvals/{approvalId}` | [DELETE](/docs/cloud/rest/api-reference/projects-branches-branch-approvals/dismiss-branch-approval-legacy-method) (deprecated) | Dismiss branch approval (legacy method) |
| `/projects/{project_reference}/branches/{branch_id}/status-checks` | [GET](/docs/cloud/rest/api-reference/projects-branches-branch-status-checks/list-branch-status-checks) | List branch status checks |
| `/projects/{project_reference}/branches/{branch_id}/status-checks/{check_name}` | [PUT](/docs/cloud/rest/api-reference/projects-branches-branch-status-checks/update-branch-status-check) | Update branch status check |
| `/projects/{project_reference}/branches/{branchId}/status-checks` | [POST](/docs/cloud/rest/api-reference/projects-branches-branch-status-checks/upsert-branch-status-check) (deprecated) | Upsert branch status check |
| `/projects/{project_reference}/commit` | [POST](/docs/cloud/rest/api-reference/projects-branches-project-commits/commit-files) | Commit files |
| `/projects/{project_reference}/branches/{branch_id}/merge-preview` | [GET](/docs/cloud/rest/api-reference/projects-branches-branch-merges/get-branch-merge-preview) | Get branch merge preview |
| `/projects/{project_reference}/branches/{branch_id}/merge-eligibility` | [GET](/docs/cloud/rest/api-reference/projects-branches-branch-merges/check-branch-merge-eligibility) | 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](/docs/cloud/rest/api-reference/projects-uploads-upload-folders/create-folder) | Create folder |
| `/projects/{project_reference}/uploads/folders/{path}` | [DELETE](/docs/cloud/rest/api-reference/projects-uploads-upload-folders/delete-folder) | Delete folder |
| `/projects/{project_reference}/uploads/folders/{path}/rename` | [POST](/docs/cloud/rest/api-reference/projects-uploads-upload-folders/rename-folder) | Rename folder |
| `/projects/{project_reference}/uploads/grants/{path}` | [GET](/docs/cloud/rest/api-reference/projects-uploads-upload-grants/list-grants), [PUT](/docs/cloud/rest/api-reference/projects-uploads-upload-grants/set-grants) | List grants; Set grants |
| `/projects/{project_reference}/uploads/grants/{path}/{user_id}` | [DELETE](/docs/cloud/rest/api-reference/projects-uploads-upload-grants/revoke-grant) | Revoke grant |
| `/projects/{project_reference}/uploads` | [GET](/docs/cloud/rest/api-reference/projects-uploads-project-uploads/list-uploads), [POST](/docs/cloud/rest/api-reference/projects-uploads-project-uploads/upload-file) | List uploads; Upload file |
| `/projects/{project_reference}/uploads/{upload_reference}` | [GET](/docs/cloud/rest/api-reference/projects-uploads-project-uploads/get-upload), [DELETE](/docs/cloud/rest/api-reference/projects-uploads-project-uploads/delete-upload) | Get upload; Delete upload |
| `/projects/{project_reference}/uploads/{upload_reference}/url` | [GET](/docs/cloud/rest/api-reference/projects-uploads-project-uploads/get-upload-download-url) | Get upload download URL |
| `/projects/{project_reference}/uploads/download-urls` | [POST](/docs/cloud/rest/api-reference/projects-uploads-project-uploads/get-upload-download-urls) | Get upload download URLs |
| `/projects/{project_reference}/uploads/{upload_reference}/move` | [POST](/docs/cloud/rest/api-reference/projects-uploads-project-uploads/move-upload) | Move upload |
| `/projects/{project_reference}/uploads/{upload_reference}/restore` | [POST](/docs/cloud/rest/api-reference/projects-uploads-project-uploads/restore-upload) | Restore upload |
| `/projects/{project_reference}/uploads/visibility/{path}` | [PUT](/docs/cloud/rest/api-reference/projects-uploads-upload-visibility/set-path-visibility), [DELETE](/docs/cloud/rest/api-reference/projects-uploads-upload-visibility/delete-path-visibility) | Set path visibility; Delete path visibility |

[Back to REST API reference](/docs/cloud/rest)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.