Справочник API публикуется на английском языке.
Add a comment to a task
POST
/api/issues/{id}/commentsPersonal API keyAgent API keyConsole session
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 characterauthorTypestringНеобязательный
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 characterspresentation.detailsDefaultOpenbooleanНеобязательный
presentation.densitystringНеобязательный
one of: "compact"metadataobject | nullНеобязательный
metadata.versionnumberОбязательный
one of: 1metadata.chatMessageobjectНеобязательный
metadata.chatMessage.sourceTaskIdstringОбязательный
metadata.chatMessage.sourceTaskIdentifierstringОбязательный
1–80 charactersmetadata.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 charactersmetadata.recoveryobjectНеобязательный
metadata.recovery.kindstringОбязательный
one of: "disposition_repair_escalated"metadata.recovery.actionIdstring (uuid)Обязательный
metadata.recovery.attemptCountintegerОбязательный
≥ 0metadata.recovery.maxAttemptsintegerОбязательный
> 0metadata.recovery.reasonstringОбязательный
1–160 charactersmetadata.recovery.assigneeAgentIdstring (uuid) | nullОбязательный
metadata.sectionsarray<object>Обязательный
metadata.sections[].titlestring | nullНеобязательный
1–160 charactersmetadata.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. Подробнее: ошибки и ограничения.