How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vonage Broadcast API

APIs relating to live streaming and broadcasting

Vonage Broadcast API is one of 59 APIs that Vonage publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 74 JSON Schema definitions.

Tagged areas include Broadcast. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 74 JSON Schemas.

This API exposes 6 operations across 5 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 0.3.2.

Requests are made against a single base URL, https://video.api.vonage.com.

6 operations 5 paths 8 schemas 2 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.3.2
Base URL
https://video.api.vonage.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Vonage Broadcast API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (Vonage-JWT). By default, every request must be authenticated.

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 2 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Broadcast 6

APIs relating to live streaming and broadcasting

GET
/v2/project/{application_id}/broadcast
List Live Streaming Broadcasts
get-broadcast-list 4 params → 200403
POST
/v2/project/{application_id}/broadcast
Start a Live Streaming Broadcast
start-broadcast 2 params body → 200400403409
GET
/v2/project/{application_id}/broadcast/{broadcast_id}
Get Information about Broadcast
get-broadcast-details 2 params → 200403
POST
/v2/project/{application_id}/broadcast/{broadcast_id}/stop
Stop Broadcast
stop-broadcast 2 params → 200400403404
PUT
/v2/project/{application_id}/broadcast/{broadcast_id}/layout
Dynamically change layout of a broadcast
change-broadcast-layout 2 params body → 200400403404
PATCH
/v2/project/{application_id}/broadcast/{broadcast_id}/streams
Selecting streams to be included in a live streaming broadcast
select-streams-for-broadcast 2 params body → 204400403404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Broadcast-Detail (16 properties), Add-Stream (3 properties), Layout (3 properties), Remove-Stream (1 property). Each schema is shown below with its type and property counts.

Stream-Mode
string
Whether streams included in the archive are selected automatically ("auto", the default) or manually ("manual"). When streams are selected automatically ("auto…
Max-Bitrate
number
The maximum video bitrate for the archive, in bits per second. This option is only valid for composed archives. Set the maximum video bitrate to control the si…
Resolution
string
The resolution of the archive, either "640x480" (SD landscape, the default), "1280x720" (HD landscape), "1920x1080" (FHD landscape), "480x640" (SD portrait), "…
Remove-Stream
object
1 property
Layout
object
3 properties
ApplicationID
string
A Vonage Application ID
Add-Stream
object
3 properties
Broadcast-Detail
object
16 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vonage-broadcast-api-openapi.yml Raw ↑

Other APIs Vonage publishes across the network.

Vonage Account API
Vonage Advanced API
Vonage Application API
Vonage Applications API
Vonage Archives API
Vonage Audio Connector API
Vonage Balance API
Vonage Basic API
Vonage Calls API
Vonage Configuration API
Vonage Conversation API
Vonage Dial In Numbers API
Where this information came from

This is an independent, third-party profile of Vonage Broadcast API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.