Create issue comment

POST/workspaces/{organizationId}/issues/{issueId}/comments

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

issueIdstringrequired

Request body

application/json

bodystringrequired

min length 1

Responses

201

Comment created

idstringrequired

organizationIdstringrequired

issueIdstring | nullrequired

documentIdstring | nullrequired

authorIdstring | nullrequired

bodystringrequired

externalIdstring | nullrequired

externalSourcestring | nullrequired

externalAuthorstring | nullrequired

resolvedAtstring | nullrequired

resolvedByIdstring | nullrequired

createdAtstringrequired

updatedAtstringrequired

202

Agent output held for review — the issue is flagged sensitive, so the comment was stored as a pending draft instead of posting

draftDraftOutputrequired

Show properties

idstringrequired

organizationIdstringrequired

entityTypestringrequired

entityIdstringrequired

issueIdstring | nullrequired

kindstringrequired

Allowed:commentfield_changemessageartifact

payloadobjectrequired

statusstringrequired

Allowed:pendingpublisheddiscarded

createdByIdstring | nullrequired

sessionIdstring | nullrequired

reviewedByIdstring | nullrequired

reviewedAtstring | nullrequired

reviewNotestring | nullrequired

publishedCommentIdstring | nullrequired

agentSlugstring | nullrequired

promptVersionstring | nullrequired

originalPayloadobject | nullrequired

slaBreachedbooleanrequired

createdAtstringrequired

updatedAtstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*issueIdpath*

Bodyapplication/json

bodystring*

Request

curl -X POST 'https://pile.nyc/workspaces/string/issues/string/comments' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "body": "string"
}'

const response = await fetch("https://pile.nyc/workspaces/string/issues/string/comments", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"body\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/workspaces/string/issues/string/comments",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"body\": \"string\"\n}",
)

Response

{
  "id": "string",
  "organizationId": "string",
  "issueId": "string",
  "documentId": "string",
  "authorId": "string",
  "body": "string",
  "externalId": "string",
  "externalSource": "string",
  "externalAuthor": "string",
  "resolvedAt": "string",
  "resolvedById": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

{
  "draft": {
    "id": "string",
    "organizationId": "string",
    "entityType": "string",
    "entityId": "string",
    "issueId": "string",
    "kind": "comment",
    "payload": {
      "property1": null,
      "property2": null
    },
    "status": "pending",
    "createdById": "string",
    "sessionId": "string",
    "reviewedById": "string",
    "reviewedAt": "string",
    "reviewNote": "string",
    "publishedCommentId": "string",
    "agentSlug": "string",
    "promptVersion": "string",
    "originalPayload": {
      "property1": null,
      "property2": null
    },
    "slaBreached": true,
    "createdAt": "string",
    "updatedAt": "string"
  }
}