La referencia de la API se publica en inglés.

Add a comment to a task

POST/api/issues/{id}/comments
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

Add a comment to a task.

Autorización

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. Cómo funcionan las claves.

Parámetros de ruta

idstringObligatorioThe task's id.

Cuerpo de la solicitud

application/json · obligatorio

clientRequestIdstring (uuid)Opcional
bodystringObligatorio
attachmentIdsarray<string (uuid)>Opcional
onBehalfOfUserIdstring | nullOpcionalat least 1 character
authorTypestringOpcionalone of: "user", "agent", "system"
presentationobject | nullOpcional
presentation.kindstringOpcionalone of: "message", "system_notice"
presentation.tonestringOpcionalone of: "neutral", "info", "success", "warning", "danger"
presentation.titlestring | nullOpcional1–160 characters
presentation.detailsDefaultOpenbooleanOpcional
presentation.densitystringOpcionalone of: "compact"
metadataobject | nullOpcional
metadata.versionnumberObligatorioone of: 1
metadata.chatMessageobjectOpcional
metadata.chatMessage.sourceTaskIdstringObligatorio
metadata.chatMessage.sourceTaskIdentifierstringObligatorio1–80 characters
metadata.chatMessage.sourceRunIdstringObligatorio
metadata.chatMessage.contentHashstringObligatoriopattern: ^[a-f0-9]{64}$
metadata.recoveryResponsibilitystringOpcionalone of: "system", "user"
metadata.attachmentPreparationobjectOpcional
metadata.attachmentPreparation.attachmentIdstringObligatorio
metadata.sourceChannelstringOpcionalone of: "slack", "github", "discord", "microsoft-teams", "telegram", "speko", "agentmail", "imessage-photon"
metadata.sourceRunIdstring (uuid) | nullOpcional
metadata.authorizationReasonstring | nullOpcional1–160 characters
metadata.recoveryobjectOpcional
metadata.recovery.kindstringObligatorioone of: "disposition_repair_escalated"
metadata.recovery.actionIdstring (uuid)Obligatorio
metadata.recovery.attemptCountintegerObligatorio≥ 0
metadata.recovery.maxAttemptsintegerObligatorio> 0
metadata.recovery.reasonstringObligatorio1–160 characters
metadata.recovery.assigneeAgentIdstring (uuid) | nullObligatorio
metadata.sectionsarray<object>Obligatorio
metadata.sections[].titlestring | nullOpcional1–160 characters
metadata.sections[].rowsarray<object>Obligatorio
reopenbooleanOpcional
resumebooleanOpcional
interruptbooleanOpcional

Respuestas

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.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Tasks