Create a task thread interaction

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

Create a task thread interaction.

Resolver policy defaults to canonical anyone for every interaction kind. not_creator and human_only are opt-in restrictions; deprecated board_or_agents and board_only inputs are accepted as compatibility aliases.

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

idstringRequiredThe task's id.

Request body

application/json · required

kindstringRequiredWhich kind of object this is; it decides which other fields apply.one of: "suggest_tasks", "ask_user_questions", "request_confirmation", "request_checkbox_confirmation", "request_item_verdicts"
resolverPolicystringOptionalone of: "anyone", "not_creator", "human_only", "board_or_agents", "board_only"
addresseeAgentIdstring (uuid) | nullOptional
addresseeUserIdstring | nullOptionalat least 1 character
idempotencyKeystring | nullOptionalat most 255 characters
sourceCommentIdstring (uuid) | nullOptional
sourceRunIdstring (uuid) | nullOptional
titlestring | nullOptionalat most 240 characters
summarystring | nullOptionalat most 1000 characters
continuationPolicystringOptionalone of: "none", "wake_assignee", "wake_assignee_on_accept"
payloadobjectRequired
payload.versionnumberRequiredone of: 1
payload.defaultParentIdstring (uuid) | nullOptional
payload.tasksarray<object>Required
payload.tasks[].clientKeystringRequired1–120 characters
payload.tasks[].parentClientKeystring | nullOptional1–120 characters
payload.tasks[].parentIdstring (uuid) | nullOptional
payload.tasks[].titlestringRequired1–240 characters
payload.tasks[].descriptionstring | nullOptional
payload.tasks[].initialPlanstring | nullOptional1–200000 characters
payload.tasks[].requiredQualityReviewobjectOptional
payload.tasks[].prioritystring | nullOptionalone of: "critical", "high", "medium", "low"
payload.tasks[].workModestring | nullOptionalone of: "standard", "ask", "planning", "skill_test"
payload.tasks[].assigneeAgentIdstring (uuid) | nullOptional
payload.tasks[].assigneeUserIdstring | nullOptionalat least 1 character
payload.tasks[].projectIdstring (uuid) | nullOptional
payload.tasks[].goalIdstring (uuid) | nullOptional
payload.tasks[].billingCodestring | nullOptionalat most 120 characters
payload.tasks[].labelsarray<string>Optionaleach at most 48 characters
payload.tasks[].hiddenInPreviewbooleanOptional

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.

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

Tasks