Add a comment to a task

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

Add a comment to a task.

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

clientRequestIdstring (uuid)Optional
bodystringRequired
attachmentIdsarray<string (uuid)>Optional
onBehalfOfUserIdstring | nullOptionalat least 1 character
authorTypestringOptionalone of: "user", "agent", "system"
presentationobject | nullOptional
presentation.kindstringOptionalone of: "message", "system_notice"
presentation.tonestringOptionalone of: "neutral", "info", "success", "warning", "danger"
presentation.titlestring | nullOptional1–160 characters
presentation.detailsDefaultOpenbooleanOptional
presentation.densitystringOptionalone of: "compact"
metadataobject | nullOptional
metadata.versionnumberRequiredone of: 1
metadata.chatMessageobjectOptional
metadata.chatMessage.sourceTaskIdstringRequired
metadata.chatMessage.sourceTaskIdentifierstringRequired1–80 characters
metadata.chatMessage.sourceRunIdstringRequired
metadata.chatMessage.contentHashstringRequiredpattern: ^[a-f0-9]{64}$
metadata.recoveryResponsibilitystringOptionalone of: "system", "user"
metadata.attachmentPreparationobjectOptional
metadata.attachmentPreparation.attachmentIdstringRequired
metadata.sourceChannelstringOptionalone of: "slack", "github", "discord", "microsoft-teams", "telegram", "speko", "agentmail", "imessage-photon"
metadata.sourceRunIdstring (uuid) | nullOptional
metadata.authorizationReasonstring | nullOptional1–160 characters
metadata.recoveryobjectOptional
metadata.recovery.kindstringRequiredone of: "disposition_repair_escalated"
metadata.recovery.actionIdstring (uuid)Required
metadata.recovery.attemptCountintegerRequired≥ 0
metadata.recovery.maxAttemptsintegerRequired> 0
metadata.recovery.reasonstringRequired1–160 characters
metadata.recovery.assigneeAgentIdstring (uuid) | nullRequired
metadata.sectionsarray<object>Required
metadata.sections[].titlestring | nullOptional1–160 characters
metadata.sections[].rowsarray<object>Required
reopenbooleanOptional
resumebooleanOptional
interruptbooleanOptional

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