Vonage Video API

Vonage Video API Broadcasts API

Live stream sessions to HLS and RTMP destinations.

GitHub OpenAPI

Operations 6

GET /project/{applicationId}/broadcast List broadcasts for a project #
POST /project/{applicationId}/broadcast Start a live streaming broadcast #
GET /project/{applicationId}/broadcast/{broadcastId} Get a broadcast #
POST /project/{applicationId}/broadcast/{broadcastId}/stop Stop a broadcast #
PUT /project/{applicationId}/broadcast/{broadcastId}/layout Change the layout of a broadcast #
PATCH /project/{applicationId}/broadcast/{broadcastId}/streams Add or remove streams from a broadcast #

Documentation

📖
Documentation
https://developer.vonage.com/en/video/guides/create-session/overview
📖
APIReference
https://developer.vonage.com/en/api/video
📖
Documentation
https://developer.vonage.com/en/video/guides/signaling
📖
Documentation
https://developer.vonage.com/en/video/guides/archiving/overview
📖
Documentation
https://developer.vonage.com/en/video/guides/broadcast/live-streaming
📖
Documentation
https://developer.vonage.com/en/video/guides/sip
📖
Documentation
https://developer.vonage.com/en/video/guides/session-monitoring
📖
Documentation
https://developer.vonage.com/en/video/guides/secure-callbacks

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/vonage-video/refs/heads/main/openapi/vonage-video-broadcasts-api-openapi.yml

Other Resources

🔗
Postman
https://raw.githubusercontent.com/api-evangelist/vonage-video/refs/heads/main/collections/vonage-video.postman_collection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/vonage-video-broadcasts-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

vonage-video-broadcasts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Vonage Video Archives Broadcasts API
  description: REST API for the Vonage Video platform (formerly OpenTok / TokBox). The Vonage Video Cloud creates and manages real-time video sessions and provides advanced server-side features including archiving (recording), live streaming broadcasts, signaling, moderation, SIP interconnect, live captions, and the Experience Composer render service. Requests are authenticated with a JWT Bearer token generated from your Vonage application credentials.
  termsOfService: https://www.vonage.com/legal/communications-apis/terms-of-use/
  contact:
    name: Vonage Video API Support
    url: https://api.support.vonage.com/hc/en-us
  version: '2.0'
servers:
- url: https://video.api.vonage.com/v2
  description: Vonage Video Cloud REST API
security:
- bearerAuth: []
tags:
- name: Broadcasts
  description: Live stream sessions to HLS and RTMP destinations.
paths:
  /project/{applicationId}/broadcast:
    get:
      operationId: listBroadcasts
      tags:
      - Broadcasts
      summary: List broadcasts for a project
      parameters:
      - $ref: '#/components/parameters/ApplicationId'
      - name: offset
        in: query
        schema:
          type: integer
      - name: count
        in: query
        schema:
          type: integer
      - name: sessionId
        in: query
        schema:
          type: string
      responses:
        '200':
          description: A list of broadcasts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BroadcastList'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      operationId: startBroadcast
      tags:
      - Broadcasts
      summary: Start a live streaming broadcast
      parameters:
      - $ref: '#/components/parameters/ApplicationId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartBroadcastRequest'
      responses:
        '200':
          description: Broadcast started.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Broadcast'
        '409':
          description: Conflict - the session is already being broadcast.
  /project/{applicationId}/broadcast/{broadcastId}:
    get:
      operationId: getBroadcast
      tags:
      - Broadcasts
      summary: Get a broadcast
      parameters:
      - $ref: '#/components/parameters/ApplicationId'
      - $ref: '#/components/parameters/BroadcastId'
      responses:
        '200':
          description: Broadcast information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Broadcast'
        '404':
          $ref: '#/components/responses/NotFound'
  /project/{applicationId}/broadcast/{broadcastId}/stop:
    post:
      operationId: stopBroadcast
      tags:
      - Broadcasts
      summary: Stop a broadcast
      parameters:
      - $ref: '#/components/parameters/ApplicationId'
      - $ref: '#/components/parameters/BroadcastId'
      responses:
        '200':
          description: Broadcast stopped.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Broadcast'
  /project/{applicationId}/broadcast/{broadcastId}/layout:
    put:
      operationId: setBroadcastLayout
      tags:
      - Broadcasts
      summary: Change the layout of a broadcast
      parameters:
      - $ref: '#/components/parameters/ApplicationId'
      - $ref: '#/components/parameters/BroadcastId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Layout'
      responses:
        '200':
          description: Layout updated.
        '403':
          $ref: '#/components/responses/Forbidden'
  /project/{applicationId}/broadcast/{broadcastId}/streams:
    patch:
      operationId: selectBroadcastStreams
      tags:
      - Broadcasts
      summary: Add or remove streams from a broadcast
      parameters:
      - $ref: '#/components/parameters/ApplicationId'
      - $ref: '#/components/parameters/BroadcastId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StreamSelectionRequest'
      responses:
        '204':
          description: Streams updated.
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    Broadcast:
      type: object
      properties:
        id:
          type: string
        sessionId:
          type: string
        applicationId:
          type: string
        status:
          type: string
          enum:
          - started
          - stopped
        createdAt:
          type: integer
          format: int64
        maxDuration:
          type: integer
        resolution:
          type: string
        broadcastUrls:
          type: object
          properties:
            hls:
              type: string
            rtmp:
              type: array
              items:
                type: object
    StartBroadcastRequest:
      type: object
      required:
      - sessionId
      - outputs
      properties:
        sessionId:
          type: string
        outputs:
          type: object
          properties:
            hls:
              type: object
              properties:
                dvr:
                  type: boolean
                lowLatency:
                  type: boolean
            rtmp:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                  serverUrl:
                    type: string
                  streamName:
                    type: string
        maxDuration:
          type: integer
          default: 7200
        maxBitrate:
          type: integer
        resolution:
          type: string
          enum:
          - 640x480
          - 1280x720
          - 1920x1080
        streamMode:
          type: string
          enum:
          - auto
          - manual
        layout:
          $ref: '#/components/schemas/Layout'
        multiBroadcastTag:
          type: string
    BroadcastList:
      type: object
      properties:
        count:
          type: integer
        items:
          type: array
          items:
            $ref: '#/components/schemas/Broadcast'
    Layout:
      type: object
      properties:
        type:
          type: string
          enum:
          - bestFit
          - pip
          - verticalPresentation
          - horizontalPresentation
          - focus
          - custom
        stylesheet:
          type: string
        screenshareType:
          type: string
    StreamSelectionRequest:
      type: object
      properties:
        addStream:
          type: string
        removeStream:
          type: string
        hasAudio:
          type: boolean
        hasVideo:
          type: boolean
  parameters:
    ApplicationId:
      name: applicationId
      in: path
      required: true
      description: The Vonage application ID (formerly OpenTok API key).
      schema:
        type: string
    BroadcastId:
      name: broadcastId
      in: path
      required: true
      schema:
        type: string
  responses:
    NotFound:
      description: The requested resource was not found.
    Forbidden:
      description: Authentication failed or the JWT is invalid.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: A JWT generated from your Vonage application's private key and application ID, sent in the Authorization header.