Create a task

POST/api/companies/{companyId}/issues
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

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.

Authorization

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. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.

Request body

application/json · required

projectIdstring (uuid) | nullOptionalpattern: ^([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) | nullOptionalpattern: ^([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) | nullOptionalpattern: ^([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})$
visibilitystringOptionalone of: "open", "private"default: "open"
parentIdstring (uuid) | nullOptionalpattern: ^([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)>Optional
unblockDescriptorobject | nullOptional
unblockDescriptor.ownerobject | stringRequired
unblockDescriptor.actionstringRequired
inheritExecutionWorkspaceFromIssueIdstring (uuid) | nullOptionalpattern: ^([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})$
titlestringOptional
descriptionstring | nullOptional
statusstringRequiredone of: "backlog", "todo", "in_progress", "in_review", "done", "blocked", "cancelled"
workModestringOptionalone of: "standard", "ask", "planning", "skill_test"default: "standard"
harnessKindstring | nullOptionalone of: "skill_test"
prioritystringOptionalone of: "critical", "high", "medium", "low"default: "medium"
reviewPolicystring | nullOptionalone of: "anyone", "not_creator", "human_only"
assigneeAgentIdstring (uuid) | nullOptionalpattern: ^([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 | nullOptional
requestDepthintegerOptional≥ 0≤ 9007199254740991
createdByUserIdstring | nullOptional
responsibleUserIdstring | nullOptional
billingCodestring | nullOptional
assigneeAdapterOverridesobject | nullOptional
assigneeAdapterOverrides.adapterConfigobjectOptional
assigneeAdapterOverrides.useProjectWorkspacebooleanOptional
executionPolicyobject | nullOptional
executionPolicy.requiredQualityReviewobjectOptional
executionPolicy.requiredQualityReview.versionnumberRequiredone of: 1
executionPolicy.requiredQualityReview.deliverablesarray<object>Requiredat least 1 itemat most 10 items
executionPolicy.modestringOptionalone of: "normal", "auto"default: "normal"
executionPolicy.commentRequiredbooleanOptionaldefault: true
executionPolicy.stagesarray<object>Optionaldefault: []
executionPolicy.stages[].idstring (uuid)Optionalpattern: ^([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[].typestringRequiredone of: "review", "approval"
executionPolicy.stages[].approvalsNeedednumberOptionalone of: 1default: 1
executionPolicy.stages[].participantsarray<object>Optionaldefault: []
executionPolicy.monitorobject | nullOptional
executionPolicy.monitor.nextCheckAtstring (date-time)Required
executionPolicy.monitor.notesstring | nullOptionalat most 500 charactersdefault: null
executionPolicy.monitor.scheduledBystringOptionalone of: "assignee", "board"default: "assignee"
executionPolicy.monitor.kindstring | nullOptionalone of: "external_service"default: null
executionPolicy.monitor.serviceNamestring | nullOptional1–120 charactersdefault: null
executionPolicy.monitor.externalRefstring | nullOptional1–500 charactersdefault: null
executionPolicy.monitor.timeoutAtstring (date-time) | nullOptionaldefault: null
executionPolicy.monitor.maxAttemptsinteger | nullOptional> 0≤ 100default: null
executionPolicy.monitor.recoveryPolicystring | nullOptionalone of: "wake_owner", "create_recovery_issue", "escalate_to_board"default: null
executionPolicy.reviewPresetobjectOptional
executionPolicy.reviewPreset.idstringRequiredone of: "low_trust_review"
executionPolicy.reviewPreset.versionnumberRequiredone of: 1
executionPolicy.reviewPreset.rawOutputDispositionstringRequiredone of: "quarantine"
executionPolicy.authorizationPolicyobjectOptional
executionPolicy.authorizationPolicy.trustPresetstringOptionalone of: "standard", "low_trust_review"
executionPolicy.authorizationPolicy.reviewPresetobjectOptional
executionPolicy.authorizationPolicy.trustBoundaryobjectOptional
executionPolicy.authorizationPolicy.assignmentPolicyobjectOptional
executionPolicy.authorizationPolicy.protectedAgentobjectOptional
executionPolicy.maxReviewRoundsinteger | nullOptional> 0≤ 50default: null
executionWorkspaceIdstring (uuid) | nullOptionalpattern: ^([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 | nullOptionalone of: "inherit", "shared_workspace", "isolated_workspace", "operator_branch", "reuse_existing", "agent_default"
workspaceSelectionobjectOptional
executionWorkspaceSettingsobject | nullOptional
executionWorkspaceSettings.modestringOptionalone of: "inherit", "shared_workspace", "isolated_workspace", "operator_branch", "reuse_existing", "agent_default"
executionWorkspaceSettings.sharedWorkspaceConcurrencystringOptionalone of: "auto", "serialize", "allow"
executionWorkspaceSettings.environmentIdstring (uuid) | nullOptionalpattern: ^([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 | nullOptional
executionWorkspaceSettings.workspaceStrategy.typestringOptionalone of: "project_primary", "git_worktree", "adapter_managed", "cloud_sandbox"
executionWorkspaceSettings.workspaceStrategy.baseRefstring | nullOptional
executionWorkspaceSettings.workspaceStrategy.branchTemplatestring | nullOptional
executionWorkspaceSettings.workspaceStrategy.existingBranchstring | nullOptional
executionWorkspaceSettings.workspaceStrategy.worktreeParentDirstring | nullOptional
executionWorkspaceSettings.workspaceStrategy.provisionCommandstring | nullOptional
executionWorkspaceSettings.workspaceStrategy.runtimeProvisionCommandstring | nullOptional
executionWorkspaceSettings.workspaceStrategy.teardownCommandstring | nullOptional
executionWorkspaceSettings.workspaceRuntimeobject | nullOptional
executionWorkspaceSettings.networkEgressobject | nullOptional
executionWorkspaceSettings.networkEgress.allowFqdnsarray<string>Optionalat most 100 itemseach at most 253 characters
executionWorkspaceSettings.networkEgress.allowCidrsarray<string>Optionalat most 100 itemseach at most 64 characters
labelIdsarray<string (uuid)>Optional
watchdogDiscoveryobject | nullOptional
watchdogDiscovery.kindstringRequiredone of: "product_bug", "platform_bug"
watchdogDiscovery.evidenceMarkdownstring | nullOptional
watchdogobject | nullOptional
watchdog.agentIdstring (uuid)Requiredpattern: ^([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 | nullOptional
taskBudgetobjectOptional
taskBudget.amountCentsintegerRequired> 0≤ 100000000
taskBudget.warnPercentintegerOptional≥ 1≤ 99default: 80
taskBudget.notifyEnabledbooleanOptionaldefault: true
taskBudget.hardStopEnabledbooleanOptionaldefault: true
initialPlanstring | nullOptional1–200000 characters
idempotencyKeystring | nullOptional1–255 characters
allowDuplicatebooleanOptionalBypasses recent-title duplicate detection; idempotency keys always replay their original taskdefault: false
onboardingFirstTaskbooleanOptional

Responses

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).

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Tasks