v4

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

Long-poll for review response (max 30s)

get/api/v1/reviews/{id}/wait

Path parameters

idstring required

Query parameters

channelstring required

Channel (agent) ID

timeoutstring

Timeout in ms (default 30000, max 30000)

Response

Review completed or timeout

status'completed' | 'timeout' required

Example response

{
  "status": "completed",
  "message": {
    "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"
      }
    ]
  }
}