Projects

Browse GraphQL domains.

Queries

OperationDescription
getFileChunkReturn file chunk.
listFileChunksList file chunks.
accountProjectsList account projects.
branchRead one branch by ID, with its status, version and base branch.
branchApprovalCollectionList a branch's approvals, including dismissed ones with their dismissal fields.
branchCollectionList the branches of a project, including its root branch.
branchMergeEligibilityCheck policies, approvals and status checks to say whether a branch can merge now.
branchMergePreviewShow the file-by-file changes a merge would apply, with conflict regions and contents.
branchPolicyCollectionList the merge policies of a project, which set the approvals and reviewers a branch needs.
branchStatusCheckCollectionList the status checks reported for a branch.
draftContentReturn draft content.
draftFilesList draft files.
fileReturn a file.
fileContentsReturn the files at the given paths.
fileDiffReturn file diff.
filesList the files.
fileTextSearchSearch file text.
fileVersionReturn file version.
fileVersionsList file versions.
projectReturn a project.
projectFavoritesLists the caller's favorite records, newest first, each with the project it points to or null when the caller can no longer read it.
projectFavoriteStatusReturns whether the caller has favorited the project, as is_favorite.
projectLabelsList project labels.
projectsList the projects.
projectTemplatesList the curated project templates, the starter projects a new project is created from, to offer a choice; returns one page of project templates, where REST needs no credentials and returns every curated template and GraphQL requires a signed-in user and returns the public templates and the templates the user is a member of.
projectTemplateSearchFind the project template that best fits a description of what the user wants to build, ranked by a model; requires a signed-in user on every surface and returns the match with its confidence and reasoning.
uploadReturn one upload's metadata by UUID or project-relative path.
uploadDownloadUrlReturn a temporary signed URL that downloads an upload's bytes, with its expiry time.
uploadGrantsList every user grant on the upload or folder that governs a path, with the target that was resolved.
uploadsList the uploads the caller can see under an optional folder prefix, newest first by default, with the visible folders in a separate list.
releaseFileReturn release file.
releaseFilesList release files.
sandboxFileRead sandbox file.
sandboxFilesList sandbox files.

Mutations

OperationDescription
deleteFileChunksDelete file chunks.
upsertFileChunksUpsert file chunks.
commitDraftContentCommit draft content.
commitFilesCommit the files.
createAccountProjectCreate account project.
createBranchCreate a branch from the project root or from another branch, snapshotting its files.
createBranchApprovalApprove a branch as the calling user, optionally with a comment.
createBranchPolicyCreate a merge policy for branches matching a pattern.
createFileCreate a file.
createProjectCreate a project.
createProjectFavoriteAdds the project to the caller's favorites and returns the favorite record; a repeat call returns the existing record.
createProjectLabelCreate project label.
createUploadCreate a pending upload at a project path and return the signed URL and headers for the PUT request that sends the bytes.
createUploadFolderCreate a folder in project uploads with a visibility.
deleteBranchDelete a branch and its uncommitted changes.
deleteBranchPolicyDelete a branch policy so it no longer blocks merges.
deleteDraftContentDelete draft content.
deleteFileDelete a file.
deleteProjectDelete a project.
deleteProjectFavoriteRemoves the project from the caller's favorites; an absent favorite answers not_found.
deleteProjectLabelDelete project label.
deleteUploadSoft-delete an upload so it no longer lists or downloads.
deleteUploadFolderDelete a folder's visibility settings and child folders and soft-delete every upload under its prefix.
deleteUploadGrantRevoke one user's grant on an upload or folder.
deleteUploadVisibilityRemove the explicit visibility on an upload path or folder so it inherits from its parent folder or the project default again.
dismissBranchApprovalDismiss an approval so it no longer counts, keeping its record with the reason.
mergeBranchMerge a branch into main or another branch, applying its file changes, deletions and the merge message to the target.
moveFileMove a file.
moveUploadMove an upload to another path in the same project, keeping its ID.
moveUploadFolderMove a folder, its child folder settings and its active uploads to a new unused path.
restoreUploadRestore a soft-deleted upload.
updateBranchStatusCheckCreate or replace one named status check on a branch.
updateDraftContentUpdate draft content.
updateFileUpdate a file.
updateProjectUpdate a project.
updateProjectLabelUpdate project label.
updateUploadGrantGrant one user read, write or admin access to an upload or folder, or change that grant, and leave the other grants unchanged.
updateUploadGrantsReplace the complete list of user grants on an upload or folder; an empty list revokes every grant.
updateUploadVisibilitySet an upload's or folder's visibility to project, public or private.
writeSandboxFilesWrite sandbox files.