v4

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-06211660.4 KB

Reviews

Get a specific review by message ID

get/api/v1/reviews/{id}

Path parameters

idstring required

Query parameters

channelstring required

Channel (agent) ID

Response

Message with review

idstring required

channelIdstring required

senderType'agent' | 'user' required

senderIdstring required

textstring

status'info' | 'success' | 'warning' | 'error'

reviewobject

Review object (null if no review)

metadataobject

Arbitrary metadata

createdAtstring required

Example response

{
  "id": "clxyz111",
  "channelId": "clxyz456",
  "senderType": "agent",
  "senderId": "clxyz456",
  "text": "Hello from agent",
  "status": "info",
  "review": {
    "type": "approval",
    "status": "pending"
  },
  "metadata": {
    "source": "automation"
  },
  "createdAt": "2025-01-01T00:00:00.000Z",
  "attachments": [
    {
      "id": "clxyz789",
      "messageId": "clxyz123",
      "pluginType": "file",
      "filename": "report.pdf",
      "mimeType": "application/pdf",
      "size": 1024,
      "storageKey": "uploads/clxyz123/report.pdf",
      "createdAt": "2025-01-01T00:00:00.000Z"
    }
  ]
}