Queries
| Operation | Description |
|---|---|
getFileChunk | Return file chunk. |
listFileChunks | List file chunks. |
accountProjects | List account projects. |
branch | Read one branch by ID, with its status, version and base branch. |
branchApprovalCollection | List a branch’s approvals, including dismissed ones with their dismissal fields. |
branchCollection | List the branches of a project, including its root branch. |
branchMergeEligibility | Check policies, approvals and status checks to say whether a branch can merge now. |
branchMergePreview | Show the file-by-file changes a merge would apply, with conflict regions and contents. |
branchPolicyCollection | List the merge policies of a project, which set the approvals and reviewers a branch needs. |
branchStatusCheckCollection | List the status checks reported for a branch. |
draftContent | Return draft content. |
draftFiles | List draft files. |
file | Return a file. |
fileContents | Return the files at the given paths. |
fileDiff | Return file diff. |
files | List the files. |
fileTextSearch | Search file text. |
fileVersion | Return file version. |
fileVersions | List file versions. |
project | Return a project. |
projectFavorites | Lists the caller’s favorite records, newest first, each with the project it points to or null when the caller can no longer read it. |
projectFavoriteStatus | Returns whether the caller has favorited the project, as is_favorite. |
projectLabels | List project labels. |
projects | List the projects. |
projectTemplates | List 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. |
projectTemplateSearch | Find 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. |
upload | Return one upload’s metadata by UUID or project-relative path. |
uploadDownloadUrl | Return a temporary signed URL that downloads an upload’s bytes, with its expiry time. |
uploadGrants | List every user grant on the upload or folder that governs a path, with the target that was resolved. |
uploads | List the uploads the caller can see under an optional folder prefix, newest first by default, with the visible folders in a separate list. |
releaseFile | Return release file. |
releaseFiles | List release files. |
sandboxFile | Read sandbox file. |
sandboxFiles | List sandbox files. |
Mutations
| Operation | Description |
|---|---|
deleteFileChunks | Delete file chunks. |
upsertFileChunks | Upsert file chunks. |
commitDraftContent | Commit draft content. |
commitFiles | Commit the files. |
createAccountProject | Create account project. |
createBranch | Create a branch from the project root or from another branch, snapshotting its files. |
createBranchApproval | Approve a branch as the calling user, optionally with a comment. |
createBranchPolicy | Create a merge policy for branches matching a pattern. |
createFile | Create a file. |
createProject | Create a project. |
createProjectFavorite | Adds the project to the caller’s favorites and returns the favorite record; a repeat call returns the existing record. |
createProjectLabel | Create project label. |
createUpload | Create a pending upload at a project path and return the signed URL and headers for the PUT request that sends the bytes. |
createUploadFolder | Create a folder in project uploads with a visibility. |
deleteBranch | Delete a branch and its uncommitted changes. |
deleteBranchPolicy | Delete a branch policy so it no longer blocks merges. |
deleteDraftContent | Delete draft content. |
deleteFile | Delete a file. |
deleteProject | Delete a project. |
deleteProjectFavorite | Removes the project from the caller’s favorites; an absent favorite answers not_found. |
deleteProjectLabel | Delete project label. |
deleteUpload | Soft-delete an upload so it no longer lists or downloads. |
deleteUploadFolder | Delete a folder’s visibility settings and child folders and soft-delete every upload under its prefix. |
deleteUploadGrant | Revoke one user’s grant on an upload or folder. |
deleteUploadVisibility | Remove the explicit visibility on an upload path or folder so it inherits from its parent folder or the project default again. |
dismissBranchApproval | Dismiss an approval so it no longer counts, keeping its record with the reason. |
mergeBranch | Merge a branch into main or another branch, applying its file changes, deletions and the merge message to the target. |
moveFile | Move a file. |
moveUpload | Move an upload to another path in the same project, keeping its ID. |
moveUploadFolder | Move a folder, its child folder settings and its active uploads to a new unused path. |
restoreUpload | Restore a soft-deleted upload. |
updateBranchStatusCheck | Create or replace one named status check on a branch. |
updateDraftContent | Update draft content. |
updateFile | Update a file. |
updateProject | Update a project. |
updateProjectLabel | Update project label. |
updateUploadGrant | Grant one user read, write or admin access to an upload or folder, or change that grant, and leave the other grants unchanged. |
updateUploadGrants | Replace the complete list of user grants on an upload or folder; an empty list revokes every grant. |
updateUploadVisibility | Set an upload’s or folder’s visibility to project, public or private. |
writeSandboxFiles | Write sandbox files. |