Add a comment to a task
POST
/api/issues/{id}/commentsPersonal API keyAgent API keyConsole session
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 | nullOptional
at least 1 characterauthorTypestringOptional
one of: "user", "agent", "system"presentationobject | nullOptional
presentation.kindstringOptional
one of: "message", "system_notice"presentation.tonestringOptional
one of: "neutral", "info", "success", "warning", "danger"presentation.titlestring | nullOptional
1–160 characterspresentation.detailsDefaultOpenbooleanOptional
presentation.densitystringOptional
one of: "compact"metadataobject | nullOptional
metadata.versionnumberRequired
one of: 1metadata.chatMessageobjectOptional
metadata.chatMessage.sourceTaskIdstringRequired
metadata.chatMessage.sourceTaskIdentifierstringRequired
1–80 charactersmetadata.chatMessage.sourceRunIdstringRequired
metadata.chatMessage.contentHashstringRequired
pattern: ^[a-f0-9]{64}$metadata.recoveryResponsibilitystringOptional
one of: "system", "user"metadata.attachmentPreparationobjectOptional
metadata.attachmentPreparation.attachmentIdstringRequired
metadata.sourceChannelstringOptional
one of: "slack", "github", "discord", "microsoft-teams", "telegram", "speko", "agentmail", "imessage-photon"metadata.sourceRunIdstring (uuid) | nullOptional
metadata.authorizationReasonstring | nullOptional
1–160 charactersmetadata.recoveryobjectOptional
metadata.recovery.kindstringRequired
one of: "disposition_repair_escalated"metadata.recovery.actionIdstring (uuid)Required
metadata.recovery.attemptCountintegerRequired
≥ 0metadata.recovery.maxAttemptsintegerRequired
> 0metadata.recovery.reasonstringRequired
1–160 charactersmetadata.recovery.assigneeAgentIdstring (uuid) | nullRequired
metadata.sectionsarray<object>Required
metadata.sections[].titlestring | nullOptional
1–160 charactersmetadata.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.