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

Create a task

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

Create a task.

Title is optional when description contains the task prompt. The server seeds a provisional title from the first 120 characters of the whitespace-normalized prompt and asks the assigned agent to refine it early. Explicit titles are preserved.

Idempotency. Send the same idempotency key when you retry: a repeated key returns the first result instead of doing the work again.

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

companyIdstringObligatoireThe organization's id.

Corps de la requête

application/json · obligatoire

projectIdstring (uuid) | nullFacultatifpattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
projectWorkspaceIdstring (uuid) | nullFacultatifpattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
goalIdstring (uuid) | nullFacultatifpattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
visibilitystringFacultatifone of: "open", "private"default: "open"
parentIdstring (uuid) | nullFacultatifpattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
blockedByIssueIdsarray<string (uuid)>Facultatif
unblockDescriptorobject | nullFacultatif
unblockDescriptor.ownerobject | stringObligatoire
unblockDescriptor.actionstringObligatoire
inheritExecutionWorkspaceFromIssueIdstring (uuid) | nullFacultatifpattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
titlestringFacultatif
descriptionstring | nullFacultatif
statusstringObligatoireone of: "backlog", "todo", "in_progress", "in_review", "done", "blocked", "cancelled"
workModestringFacultatifone of: "standard", "ask", "planning", "skill_test"default: "standard"
harnessKindstring | nullFacultatifone of: "skill_test"
prioritystringFacultatifone of: "critical", "high", "medium", "low"default: "medium"
reviewPolicystring | nullFacultatifone of: "anyone", "not_creator", "human_only"
assigneeAgentIdstring (uuid) | nullFacultatifpattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
assigneeUserIdstring | nullFacultatif
requestDepthintegerFacultatif≥ 0≤ 9007199254740991
createdByUserIdstring | nullFacultatif
responsibleUserIdstring | nullFacultatif
billingCodestring | nullFacultatif
assigneeAdapterOverridesobject | nullFacultatif
assigneeAdapterOverrides.adapterConfigobjectFacultatif
assigneeAdapterOverrides.useProjectWorkspacebooleanFacultatif
executionPolicyobject | nullFacultatif
executionPolicy.requiredQualityReviewobjectFacultatif
executionPolicy.requiredQualityReview.versionnumberObligatoireone of: 1
executionPolicy.requiredQualityReview.deliverablesarray<object>Obligatoireat least 1 itemat most 10 items
executionPolicy.modestringFacultatifone of: "normal", "auto"default: "normal"
executionPolicy.commentRequiredbooleanFacultatifdefault: true
executionPolicy.stagesarray<object>Facultatifdefault: []
executionPolicy.stages[].idstring (uuid)Facultatifpattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
executionPolicy.stages[].typestringObligatoireone of: "review", "approval"
executionPolicy.stages[].approvalsNeedednumberFacultatifone of: 1default: 1
executionPolicy.stages[].participantsarray<object>Facultatifdefault: []
executionPolicy.monitorobject | nullFacultatif
executionPolicy.monitor.nextCheckAtstring (date-time)Obligatoire
executionPolicy.monitor.notesstring | nullFacultatifat most 500 charactersdefault: null
executionPolicy.monitor.scheduledBystringFacultatifone of: "assignee", "board"default: "assignee"
executionPolicy.monitor.kindstring | nullFacultatifone of: "external_service"default: null
executionPolicy.monitor.serviceNamestring | nullFacultatif1–120 charactersdefault: null
executionPolicy.monitor.externalRefstring | nullFacultatif1–500 charactersdefault: null
executionPolicy.monitor.timeoutAtstring (date-time) | nullFacultatifdefault: null
executionPolicy.monitor.maxAttemptsinteger | nullFacultatif> 0≤ 100default: null
executionPolicy.monitor.recoveryPolicystring | nullFacultatifone of: "wake_owner", "create_recovery_issue", "escalate_to_board"default: null
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≤ 50default: null
executionWorkspaceIdstring (uuid) | nullFacultatifpattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
executionWorkspacePreferencestring | nullFacultatifone of: "inherit", "shared_workspace", "isolated_workspace", "operator_branch", "reuse_existing", "agent_default"
workspaceSelectionobjectFacultatif
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) | nullFacultatifpattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
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>Facultatifat most 100 itemseach at most 253 characters
executionWorkspaceSettings.networkEgress.allowCidrsarray<string>Facultatifat most 100 itemseach at most 64 characters
labelIdsarray<string (uuid)>Facultatif
watchdogDiscoveryobject | nullFacultatif
watchdogDiscovery.kindstringObligatoireone of: "product_bug", "platform_bug"
watchdogDiscovery.evidenceMarkdownstring | nullFacultatif
watchdogobject | nullFacultatif
watchdog.agentIdstring (uuid)Obligatoirepattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
watchdog.instructionsstring | nullFacultatif
taskBudgetobjectFacultatif
taskBudget.amountCentsintegerObligatoire> 0≤ 100000000
taskBudget.warnPercentintegerFacultatif≥ 1≤ 99default: 80
taskBudget.notifyEnabledbooleanFacultatifdefault: true
taskBudget.hardStopEnabledbooleanFacultatifdefault: true
initialPlanstring | nullFacultatif1–200000 characters
idempotencyKeystring | nullFacultatif1–255 characters
allowDuplicatebooleanFacultatifBypasses recent-title duplicate detection; idempotency keys always replay their original taskdefault: false
onboardingFirstTaskbooleanFacultatif

Réponses

201SuccessCreated; the body holds the new resource.
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.
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