Comments

Endpoints for collaborating on assistants through comments.

GET /api/assistants/{id}/comments

List comments on an assistant.

Authentication: Required (AI seat)

Response:

{
  "_links": {
    "self": { "href": "/api/assistants/{id}/comments" }
  },
  "_embedded": {
    "inf:comment": [
      {
        "id": "comment-123",
        "assistantId": "team:sales-assistant",
        "username": "admin",
        "comment": "Should we add a skill for quarterly forecasting?",
        "createdAt": "2024-02-08T14:30:00Z",
        "user": {
          "username": "admin",
          "displayName": "Administrator",
          "_links": {
            "self": { "href": "/api/users/admin" }
          }
        }
      }
    ]
  },
  "start": 0,
  "count": 1,
  "total": 1
}

---

POST /api/assistants/{id}/comments

Add a comment to an assistant.

Authentication: Required (AI seat)

Request Body:

Field	Type	Required	Description
comment	string	Yes	Comment text

Example Request:

{
  "comment": "This assistant needs better instructions for handling edge cases."
}

Response:

{
  "id": "comment-456",
  "assistantId": "team:sales-assistant",
  "username": "admin",
  "comment": "This assistant needs better instructions for handling edge cases.",
  "createdAt": "2024-02-09T10:00:00Z",
  "_links": {
    "self": { "href": "/api/assistants/team:sales-assistant/comments/comment-456" }
  }
}

Status: 201 Created

---

Use Cases

• Feedback - Provide suggestions for improvement
• Documentation - Document assistant behavior and quirks
• Collaboration - Discuss changes before implementation
• Issue Tracking - Report problems or unexpected behavior

Best Practice

Use comments to document why certain instructions or skills were added, making future maintenance easier.