Comments API
Comments allow users to leave feedback or record decisions about a run.
List Comments for a Run
GET /runs/:id/comments
Parameter | Description |
---|---|
id | The ID of the run. |
Sample Request
Sample Reponse
Show a Comment
GET /comments/:id
Parameter | Description |
---|---|
id | The ID of the comment. |
Sample Request
Sample Response
Create Comment
POST /runs/:id/comments
Parameter | Description |
---|---|
id | The ID of the run. |
Request Body
This POST endpoint requires a JSON object with the following properties as the request payload.
Key Path | Type | Default | Description |
---|---|---|---|
data.type | string | Must be "comments" . | |
data.attributes.body | string | The body of the comment. |
Sample Payload
Sample Request
Sample Response