Set Upstream

Block or pass real-time captions generated by Verbit's AI.

The upstream state determines whether captions are being sent or blocked:

  • Blocked: The upstream is blocked, so Verbit captions are allowed and actively being sent.
  • Passed: The upstream is passed, so Verbit captions are blocked and not sent.

Request and Response

Method: POST
URL: https://realtime.verbit.co/api/v1/session/{order_id}/upstream

Request Body:

{
  "upstream": "block" | "pass"
}

Response:

{
  "state": {
    "upstream": "block" | "pass"
  }
}