La référence de l'API est publiée en anglais.

Update project properties and defaults

PATCH/api/projects/{id}
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

Update project properties and defaults.

Save project properties and defaults. The description holds shared project context and guidance, including checklists; goalIds links the project to its goals. Read the project back to verify the saved fields. Updating description or goalIds does not rewrite existing tasks or the inputs already admitted to active native runs; changing existing work is a separate operation. Environment and executionWorkspacePolicy fields configure separate project settings and are not required to save description or goalIds. Archiving a project (archivedAt set to the current time) hides it from the sidebar and project selectors and keeps the project, its tasks and their history; no data is removed. Restoring sets archivedAt to null. A person unarchives a project on that project's own Configuration page, //projects//configuration, with the Unarchive button; give them that page as a Markdown link. Archived projects are not restored from the organization Status page.

Autorisation

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Fonctionnement des clés.

Paramètres de chemin

idstringObligatoireThe project's id.

Corps de la requête

application/json · obligatoire

goalIdstring (uuid) | nullFacultatif
goalIdsarray<string (uuid)>Facultatif
namestringFacultatifat least 1 character
descriptionstring | nullFacultatif
visibilitystringFacultatifone of: "open", "private"
statusstringFacultatifone of: "backlog", "planned", "in_progress", "completed", "cancelled"
leadAgentIdstring (uuid) | nullFacultatif
decisionOwnerUserIdstring | nullFacultatifat least 1 character
targetDatestring | nullFacultatif
colorstring | nullFacultatif
iconstring | nullFacultatifone of: "folder", "rocket", "code", "terminal", "database", "globe", "package", "boxes", "box", "layers", "briefcase", "compass", "target", "flame", "zap", "star", "bug", "wrench", "hammer", "lightbulb", "sparkles", "shield", "lock", "search", "cog", "brain", "cpu", "git-branch", "file-code", "puzzle", "gem", "atom", "heart", "mail", "message-square", "crown", "radar", "telescope", "hexagon"
envobject<string, string | object> | nullFacultatif
executionWorkspacePolicyobject | nullFacultatif
executionWorkspacePolicy.enabledbooleanObligatoire
executionWorkspacePolicy.sharedWorkspaceConcurrencystringFacultatifone of: "auto", "serialize", "allow"
executionWorkspacePolicy.defaultModestringFacultatifone of: "shared_workspace", "isolated_workspace", "operator_branch", "adapter_default"
executionWorkspacePolicy.allowIssueOverridebooleanFacultatif
executionWorkspacePolicy.defaultProjectWorkspaceIdstring (uuid) | nullFacultatif
executionWorkspacePolicy.environmentIdstring (uuid) | nullFacultatif
executionWorkspacePolicy.storageProviderPluginIdstring (uuid) | nullFacultatif
executionWorkspacePolicy.workspaceStrategyobject | nullFacultatif
executionWorkspacePolicy.workspaceStrategy.typestringFacultatifone of: "project_primary", "git_worktree", "adapter_managed", "cloud_sandbox"
executionWorkspacePolicy.workspaceStrategy.baseRefstring | nullFacultatif
executionWorkspacePolicy.workspaceStrategy.branchTemplatestring | nullFacultatif
executionWorkspacePolicy.workspaceStrategy.worktreeParentDirstring | nullFacultatif
executionWorkspacePolicy.workspaceStrategy.provisionCommandstring | nullFacultatif
executionWorkspacePolicy.workspaceStrategy.runtimeProvisionCommandstring | nullFacultatif
executionWorkspacePolicy.workspaceStrategy.teardownCommandstring | nullFacultatif
executionWorkspacePolicy.workspaceRuntimeobject | nullFacultatif
executionWorkspacePolicy.branchPolicyobject | nullFacultatif
executionWorkspacePolicy.pullRequestPolicyobject | nullFacultatif
executionWorkspacePolicy.runtimePolicyobject | nullFacultatif
executionWorkspacePolicy.cleanupPolicyobject | nullFacultatif
executionWorkspacePolicy.authorizationPolicyobject | nullFacultatif
executionWorkspacePolicy.authorizationPolicy.trustPresetstringFacultatifone of: "standard", "low_trust_review"
executionWorkspacePolicy.authorizationPolicy.reviewPresetobjectFacultatif
executionWorkspacePolicy.authorizationPolicy.trustBoundaryobjectFacultatif
executionWorkspacePolicy.authorizationPolicy.assignmentPolicyobjectFacultatif
executionWorkspacePolicy.authorizationPolicy.protectedAgentobjectFacultatif
archivedAtstring (date-time) | nullFacultatif

Réponses

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Projects