API referansı İngilizce yayımlanır.
Add a comment to a task
POST
/api/issues/{id}/commentsPersonal API keyAgent API keyConsole session
Add a comment to a task.
Yetkilendirme
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. Anahtarlar nasıl çalışır.
Yol parametreleri
idstringZorunluThe task's id.
İstek gövdesi
application/json · zorunlu
clientRequestIdstring (uuid)İsteğe bağlı
bodystringZorunlu
attachmentIdsarray<string (uuid)>İsteğe bağlı
onBehalfOfUserIdstring | nullİsteğe bağlı
at least 1 characterauthorTypestringİsteğe bağlı
one of: "user", "agent", "system"presentationobject | nullİsteğe bağlı
presentation.kindstringİsteğe bağlı
one of: "message", "system_notice"presentation.tonestringİsteğe bağlı
one of: "neutral", "info", "success", "warning", "danger"presentation.titlestring | nullİsteğe bağlı
1–160 characterspresentation.detailsDefaultOpenbooleanİsteğe bağlı
presentation.densitystringİsteğe bağlı
one of: "compact"metadataobject | nullİsteğe bağlı
metadata.versionnumberZorunlu
one of: 1metadata.chatMessageobjectİsteğe bağlı
metadata.chatMessage.sourceTaskIdstringZorunlu
metadata.chatMessage.sourceTaskIdentifierstringZorunlu
1–80 charactersmetadata.chatMessage.sourceRunIdstringZorunlu
metadata.chatMessage.contentHashstringZorunlu
pattern: ^[a-f0-9]{64}$metadata.recoveryResponsibilitystringİsteğe bağlı
one of: "system", "user"metadata.attachmentPreparationobjectİsteğe bağlı
metadata.attachmentPreparation.attachmentIdstringZorunlu
metadata.sourceChannelstringİsteğe bağlı
one of: "slack", "github", "discord", "microsoft-teams", "telegram", "speko", "agentmail", "imessage-photon"metadata.sourceRunIdstring (uuid) | nullİsteğe bağlı
metadata.authorizationReasonstring | nullİsteğe bağlı
1–160 charactersmetadata.recoveryobjectİsteğe bağlı
metadata.recovery.kindstringZorunlu
one of: "disposition_repair_escalated"metadata.recovery.actionIdstring (uuid)Zorunlu
metadata.recovery.attemptCountintegerZorunlu
≥ 0metadata.recovery.maxAttemptsintegerZorunlu
> 0metadata.recovery.reasonstringZorunlu
1–160 charactersmetadata.recovery.assigneeAgentIdstring (uuid) | nullZorunlu
metadata.sectionsarray<object>Zorunlu
metadata.sections[].titlestring | nullİsteğe bağlı
1–160 charactersmetadata.sections[].rowsarray<object>Zorunlu
reopenbooleanİsteğe bağlı
resumebooleanİsteğe bağlı
interruptbooleanİsteğe bağlı
Yanıtlar
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.
Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.