La referencia de la API se publica en inglés.

Update project properties and defaults

PATCH/api/projects/{id}
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

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.

Autorización

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. Cómo funcionan las claves.

Parámetros de ruta

idstringObligatorioThe project's id.

Cuerpo de la solicitud

application/json · obligatorio

goalIdstring (uuid) | nullOpcional
goalIdsarray<string (uuid)>Opcional
namestringOpcionalat least 1 character
descriptionstring | nullOpcional
visibilitystringOpcionalone of: "open", "private"
statusstringOpcionalone of: "backlog", "planned", "in_progress", "completed", "cancelled"
leadAgentIdstring (uuid) | nullOpcional
decisionOwnerUserIdstring | nullOpcionalat least 1 character
targetDatestring | nullOpcional
colorstring | nullOpcional
iconstring | nullOpcionalone 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> | nullOpcional
executionWorkspacePolicyobject | nullOpcional
executionWorkspacePolicy.enabledbooleanObligatorio
executionWorkspacePolicy.sharedWorkspaceConcurrencystringOpcionalone of: "auto", "serialize", "allow"
executionWorkspacePolicy.defaultModestringOpcionalone of: "shared_workspace", "isolated_workspace", "operator_branch", "adapter_default"
executionWorkspacePolicy.allowIssueOverridebooleanOpcional
executionWorkspacePolicy.defaultProjectWorkspaceIdstring (uuid) | nullOpcional
executionWorkspacePolicy.environmentIdstring (uuid) | nullOpcional
executionWorkspacePolicy.storageProviderPluginIdstring (uuid) | nullOpcional
executionWorkspacePolicy.workspaceStrategyobject | nullOpcional
executionWorkspacePolicy.workspaceStrategy.typestringOpcionalone of: "project_primary", "git_worktree", "adapter_managed", "cloud_sandbox"
executionWorkspacePolicy.workspaceStrategy.baseRefstring | nullOpcional
executionWorkspacePolicy.workspaceStrategy.branchTemplatestring | nullOpcional
executionWorkspacePolicy.workspaceStrategy.worktreeParentDirstring | nullOpcional
executionWorkspacePolicy.workspaceStrategy.provisionCommandstring | nullOpcional
executionWorkspacePolicy.workspaceStrategy.runtimeProvisionCommandstring | nullOpcional
executionWorkspacePolicy.workspaceStrategy.teardownCommandstring | nullOpcional
executionWorkspacePolicy.workspaceRuntimeobject | nullOpcional
executionWorkspacePolicy.branchPolicyobject | nullOpcional
executionWorkspacePolicy.pullRequestPolicyobject | nullOpcional
executionWorkspacePolicy.runtimePolicyobject | nullOpcional
executionWorkspacePolicy.cleanupPolicyobject | nullOpcional
executionWorkspacePolicy.authorizationPolicyobject | nullOpcional
executionWorkspacePolicy.authorizationPolicy.trustPresetstringOpcionalone of: "standard", "low_trust_review"
executionWorkspacePolicy.authorizationPolicy.reviewPresetobjectOpcional
executionWorkspacePolicy.authorizationPolicy.trustBoundaryobjectOpcional
executionWorkspacePolicy.authorizationPolicy.assignmentPolicyobjectOpcional
executionWorkspacePolicy.authorizationPolicy.protectedAgentobjectOpcional
archivedAtstring (date-time) | nullOpcional

Respuestas

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.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Projects