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

Update a task

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

Update a task.

When posting a comment, attachmentIds selects up to 20 unique uploaded attachments from this exact task and organization. The comment, attachment binding, and task update commit atomically. attachmentIds without a comment is rejected; Markdown links alone do not bind uploads. For a prepared backlog task, send exactly status=todo and expectedStatusVersion from the task response. The locked promotion returns 409 if the status or assignment changed. Other mutation fields with this guard return 422.

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 task's id.

Corps de la requête

application/json · obligatoire

projectIdstring (uuid) | nullFacultatif
projectWorkspaceIdstring (uuid) | nullFacultatif
goalIdstring (uuid) | nullFacultatif
visibilitystringFacultatifone of: "open", "private"
parentIdstring (uuid) | nullFacultatif
blockedByIssueIdsarray<string (uuid)>Facultatif
unblockDescriptorobject | nullFacultatif
unblockDescriptor.ownerobject | stringObligatoire
unblockDescriptor.actionstringObligatoire
inheritExecutionWorkspaceFromIssueIdstring (uuid) | nullFacultatif
titlestringFacultatifat least 1 character
descriptionstring | nullFacultatif
statusstringFacultatifone of: "backlog", "todo", "in_progress", "in_review", "done", "blocked", "cancelled"
workModestringFacultatifone of: "standard", "ask", "planning", "skill_test"
harnessKindstring | nullFacultatifone of: "skill_test"
prioritystringFacultatifone of: "critical", "high", "medium", "low"
reviewPolicystring | nullFacultatifone of: "anyone", "not_creator", "human_only"
assigneeAgentIdstring | nullFacultatifat least 1 character
assigneeUserIdstring | nullFacultatif
requestDepthintegerFacultatif≥ 0
billingCodestring | nullFacultatif
assigneeAdapterOverridesobject | nullFacultatif
assigneeAdapterOverrides.adapterConfigobjectFacultatif
assigneeAdapterOverrides.useProjectWorkspacebooleanFacultatif
executionPolicyobject | nullFacultatif
executionPolicy.requiredQualityReviewobjectFacultatif
executionPolicy.requiredQualityReview.versionnumberObligatoireone of: 1
executionPolicy.requiredQualityReview.deliverablesarray<object>Obligatoire
executionPolicy.modestringFacultatifone of: "normal", "auto"
executionPolicy.commentRequiredbooleanFacultatif
executionPolicy.stagesarray<object>Facultatif
executionPolicy.stages[].idstring (uuid)Facultatif
executionPolicy.stages[].typestringObligatoireone of: "review", "approval"
executionPolicy.stages[].approvalsNeedednumberFacultatifone of: 1
executionPolicy.stages[].participantsarray<object>Facultatif
executionPolicy.monitorobject | nullFacultatif
executionPolicy.monitor.nextCheckAtstring (date-time)Obligatoire
executionPolicy.monitor.notesstring | nullFacultatifat most 500 characters
executionPolicy.monitor.scheduledBystringFacultatifone of: "assignee", "board"
executionPolicy.monitor.kindstring | nullFacultatifone of: "external_service"
executionPolicy.monitor.serviceNamestring | nullFacultatif1–120 characters
executionPolicy.monitor.externalRefstring | nullFacultatif1–500 characters
executionPolicy.monitor.timeoutAtstring (date-time) | nullFacultatif
executionPolicy.monitor.maxAttemptsinteger | nullFacultatif> 0≤ 100
executionPolicy.monitor.recoveryPolicystring | nullFacultatifone of: "wake_owner", "create_recovery_issue", "escalate_to_board"
executionPolicy.reviewPresetobjectFacultatif
executionPolicy.reviewPreset.idstringObligatoireone of: "low_trust_review"
executionPolicy.reviewPreset.versionnumberObligatoireone of: 1
executionPolicy.reviewPreset.rawOutputDispositionstringObligatoireone of: "quarantine"
executionPolicy.authorizationPolicyobjectFacultatif
executionPolicy.authorizationPolicy.trustPresetstringFacultatifone of: "standard", "low_trust_review"
executionPolicy.authorizationPolicy.reviewPresetobjectFacultatif
executionPolicy.authorizationPolicy.trustBoundaryobjectFacultatif
executionPolicy.authorizationPolicy.assignmentPolicyobjectFacultatif
executionPolicy.authorizationPolicy.protectedAgentobjectFacultatif
executionPolicy.maxReviewRoundsinteger | nullFacultatif> 0≤ 50
executionWorkspaceIdstring (uuid) | nullFacultatif
executionWorkspacePreferencestring | nullFacultatifone of: "inherit", "shared_workspace", "isolated_workspace", "operator_branch", "reuse_existing", "agent_default"
executionWorkspaceSettingsobject | nullFacultatif
executionWorkspaceSettings.modestringFacultatifone of: "inherit", "shared_workspace", "isolated_workspace", "operator_branch", "reuse_existing", "agent_default"
executionWorkspaceSettings.sharedWorkspaceConcurrencystringFacultatifone of: "auto", "serialize", "allow"
executionWorkspaceSettings.environmentIdstring (uuid) | nullFacultatif
executionWorkspaceSettings.workspaceStrategyobject | nullFacultatif
executionWorkspaceSettings.workspaceStrategy.typestringFacultatifone of: "project_primary", "git_worktree", "adapter_managed", "cloud_sandbox"
executionWorkspaceSettings.workspaceStrategy.baseRefstring | nullFacultatif
executionWorkspaceSettings.workspaceStrategy.branchTemplatestring | nullFacultatif
executionWorkspaceSettings.workspaceStrategy.existingBranchstring | nullFacultatif
executionWorkspaceSettings.workspaceStrategy.worktreeParentDirstring | nullFacultatif
executionWorkspaceSettings.workspaceStrategy.provisionCommandstring | nullFacultatif
executionWorkspaceSettings.workspaceStrategy.runtimeProvisionCommandstring | nullFacultatif
executionWorkspaceSettings.workspaceStrategy.teardownCommandstring | nullFacultatif
executionWorkspaceSettings.workspaceRuntimeobject | nullFacultatif
executionWorkspaceSettings.networkEgressobject | nullFacultatif
executionWorkspaceSettings.networkEgress.allowFqdnsarray<string>Facultatifeach at most 253 characters
executionWorkspaceSettings.networkEgress.allowCidrsarray<string>Facultatifeach at most 64 characters
labelIdsarray<string (uuid)>Facultatif
watchdogDiscoveryobject | nullFacultatif
watchdogDiscovery.kindstringObligatoireone of: "product_bug", "platform_bug"
watchdogDiscovery.evidenceMarkdownstring | nullFacultatif
expectedStatusVersionintegerFacultatif≥ 0
expectedExecutionPolicyobject | nullFacultatif
commentstringFacultatif
commentClientRequestIdstring (uuid)Facultatif
attachmentIdsarray<string (uuid)>Facultatif
onBehalfOfUserIdstring | nullFacultatifat least 1 character
reviewInteractionIdstring (uuid)Facultatif
reviewRequestobject | nullFacultatif
reviewRequest.instructionsstringObligatoire1–20000 characters
reopenbooleanFacultatif
resumebooleanFacultatif
interruptbooleanFacultatif
deferWakeForGoalbooleanFacultatif
hiddenAtstring (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.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

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

Tasks