> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getcliq.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Stream review messages

> Streams a review's new chat messages as server-sent events (checked every 2 seconds). The
stream ends after 5 minutes with a `timeout` event; reconnect with the last `after_id`.

Requires a realm member (or higher) with the `reviews.view` permission on the realm that owns the review given by `review_id` (query string).



## OpenAPI

````yaml /openapi/hub-by-tag/hub-reviews.yaml get /v1/reviews/stream_messages
openapi: 3.0.3
info:
  title: 'CliqHub API: Reviews'
  version: 1.0.0
  description: >-
    Human-in-the-loop (HUG) reviews. When a team reaches a review phase, the
    agent opens a

    review; CliqHub notifies the reviewers (people and channels named in the
    team or at run

    start) and shows the review in their inbox. A reviewer reads it, can chat
    with the agent,

    and gives a verdict (`PASS`, `REJECT` or `ROUTE:<phase>`); with an `all`
    policy every group

    must answer first. The agent then picks up the decision and acknowledges it.


    A review is `pending`, then `decided`, then `completed` once the agent
    acknowledged it, or

    `expired` when nobody answered in time (4 hours by default).
servers:
  - url: https://{host}
    variables:
      host:
        default: cliqhub.io
        description: CliqHub host
security: []
tags:
  - name: Reviews
    description: >-
      Human-in-the-loop (HUG) reviews. When a team reaches a review phase, the
      agent opens a

      review; CliqHub notifies the reviewers (people and channels named in the
      team or at run

      start) and shows the review in their inbox. A reviewer reads it, can chat
      with the agent,

      and gives a verdict (`PASS`, `REJECT` or `ROUTE:<phase>`); with an `all`
      policy every group

      must answer first. The agent then picks up the decision and acknowledges
      it.


      A review is `pending`, then `decided`, then `completed` once the agent
      acknowledged it, or

      `expired` when nobody answered in time (4 hours by default).
paths:
  /v1/reviews/stream_messages:
    get:
      tags:
        - Reviews
      summary: Stream review messages
      description: >-
        Streams a review's new chat messages as server-sent events (checked
        every 2 seconds). The

        stream ends after 5 minutes with a `timeout` event; reconnect with the
        last `after_id`.


        Requires a realm member (or higher) with the `reviews.view` permission
        on the realm that owns the review given by `review_id` (query string).
      operationId: GET_v1_reviews_stream_messages
      parameters:
        - in: query
          name: review_id
          required: true
          description: The review.
          schema:
            type: string
        - in: query
          name: after_id
          required: false
          description: Only messages after this one.
          schema:
            type: string
      responses:
        '200':
          description: A `text/event-stream` of review messages.
          content:
            text/event-stream:
              schema:
                type: string
                description: >-
                  Starts with a `: connected` comment. Each message is `data:
                  <ReviewMessage JSON>`. After 5 minutes `event: timeout` with
                  `data: reconnect`, then the stream closes.
              example: >
                : connected


                data:
                {"id":"2","review_id":"4a3b2c1d-0e9f-4a8b-9c7d-6e5f4a3b2c1d","role":"user","text":"Can
                you also update the
                changelog?","sender_id":"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d","created_at":"2026-10-07T10:17:00Z"}
        '401':
          description: >-
            `unauthorized`: No `Authorization` header, or the token is
            malformed, expired or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                unauthorized:
                  summary: unauthorized
                  value:
                    ok: false
                    error:
                      code: unauthorized
                      message: Authentication required
        '403':
          description: >-
            `forbidden`: You can see the record but your role in its realm is
            too low or lacks the required permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                forbidden:
                  summary: forbidden
                  value:
                    ok: false
                    error:
                      code: forbidden
                      message: You do not have access to do this
        '404':
          description: >-
            `not_found`: The review does not exist or is in a realm you cannot
            see (404 rather than 403, so its existence is not revealed).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                not_found:
                  summary: not_found
                  value:
                    ok: false
                    error:
                      code: not_found
                      message: Not found
        '500':
          description: >-
            `internal_error`: An unexpected server fault. Retry later; if it
            persists, report it with the time of the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                internal_error:
                  summary: internal_error
                  value:
                    ok: false
                    error: Internal server error
                    code: internal_error
      security:
        - BearerAuth: []
components:
  schemas:
    HubErr:
      type: object
      required:
        - ok
        - error
      description: >-
        Every failure. Route-policy denials (401/403/404, and 400 when neither
        realm_id nor org_id was sent) answer `error` as `{ code, message }`;
        errors raised by the endpoint answer `error` as the message with the
        code beside it in `code`. Every error has a code. See
        [Errors](/hub-api/errors).
      properties:
        ok:
          type: boolean
          description: Always false on error
        error:
          description: The message, or `{ code, message }` for an access denial.
          oneOf:
            - type: string
            - type: object
              required:
                - code
                - message
              properties:
                code:
                  type: string
                message:
                  type: string
        code:
          type: string
          description: Stable error code of an endpoint error.
        details:
          type: object
          additionalProperties: true
          description: Structured detail, when there is some.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: cliq_tok_* | cliq_dt_*
      description: >-
        User PAT (`cliq_tok_…`, including session-scoped) or realm token
        (`cliq_dt_…`).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.