Справочник API публикуется на английском языке.

Add a comment to a task

POST/api/issues/{id}/comments
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Add a comment to a task.

Авторизация

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. Как работают ключи.

Параметры пути

idstringОбязательныйThe task's id.

Тело запроса

application/json · обязательно

clientRequestIdstring (uuid)Необязательный
bodystringОбязательный
attachmentIdsarray<string (uuid)>Необязательный
onBehalfOfUserIdstring | nullНеобязательныйat least 1 character
authorTypestringНеобязательныйone of: "user", "agent", "system"
presentationobject | nullНеобязательный
presentation.kindstringНеобязательныйone of: "message", "system_notice"
presentation.tonestringНеобязательныйone of: "neutral", "info", "success", "warning", "danger"
presentation.titlestring | nullНеобязательный1–160 characters
presentation.detailsDefaultOpenbooleanНеобязательный
presentation.densitystringНеобязательныйone of: "compact"
metadataobject | nullНеобязательный
metadata.versionnumberОбязательныйone of: 1
metadata.chatMessageobjectНеобязательный
metadata.chatMessage.sourceTaskIdstringОбязательный
metadata.chatMessage.sourceTaskIdentifierstringОбязательный1–80 characters
metadata.chatMessage.sourceRunIdstringОбязательный
metadata.chatMessage.contentHashstringОбязательныйpattern: ^[a-f0-9]{64}$
metadata.recoveryResponsibilitystringНеобязательныйone of: "system", "user"
metadata.attachmentPreparationobjectНеобязательный
metadata.attachmentPreparation.attachmentIdstringОбязательный
metadata.sourceChannelstringНеобязательныйone of: "slack", "github", "discord", "microsoft-teams", "telegram", "speko", "agentmail", "imessage-photon"
metadata.sourceRunIdstring (uuid) | nullНеобязательный
metadata.authorizationReasonstring | nullНеобязательный1–160 characters
metadata.recoveryobjectНеобязательный
metadata.recovery.kindstringОбязательныйone of: "disposition_repair_escalated"
metadata.recovery.actionIdstring (uuid)Обязательный
metadata.recovery.attemptCountintegerОбязательный≥ 0
metadata.recovery.maxAttemptsintegerОбязательный> 0
metadata.recovery.reasonstringОбязательный1–160 characters
metadata.recovery.assigneeAgentIdstring (uuid) | nullОбязательный
metadata.sectionsarray<object>Обязательный
metadata.sections[].titlestring | nullНеобязательный1–160 characters
metadata.sections[].rowsarray<object>Обязательный
reopenbooleanНеобязательный
resumebooleanНеобязательный
interruptbooleanНеобязательный

Ответы

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.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Tasks