Suggestions

close search

Add Messaging, Voice, and Authentication to your apps with Vonage Communications APIs

Visit the Vonage API Developer Portal
Developer Documentation moved on August 7, 2026. Future updates are available only at → https://developer.vonage.com/en/opentok/overview

Vonage Video API Developer Guides

Learn the details of building on the Vonage Video API platform.

Learn the Basics

Basic Vonage Video API functionality


Creating a session
Create an Vonage Video API session that clients can connect to, publish streams to, and subscribe to streams within.
Creating a token
Create a token that grants a client access to a session.
Joining a session
Connect to and disconnect from Vonage Video API sessions, and find out when other clients have connected and disconnected.
Publishing a stream
Publish a video and audio stream in a session that others can view by subscribing to it.
Subscribing to a stream
View the video and audio stream published by another.

Customization


Adjusting audio and video
Toggle video and audio in a stream.
Customizing the UI
Configure the appearance of Vonage Video API elements.
Configuring publisher video constraints
Update a publisher’s preferred video resolution and frame rate.

Advanced Features


Using the Vonage Media Processor
Use the Vonage Media Processor library to apply audio and video transformers to published streams. You can also and applying your own custom media tranformations to published streams.
Live captions
Use the Live Captions API to transcribe audio streams and generate real-time captions for your application.
Experience Composer
Experience Composer captures immersive web application experiences — including whiteboards, chats, branding, and customer elements — for both video broadcast and recording.
Enterprise environment
Using the Video API Enterprise environment.
Screen sharing
Sharing your screen with other clients.
Monitoring sessions
Monitoring session activity from your app server.
Service Disruption Callbacks
How to receive server-rotation session monitoring callbacks and recover connections, archives, broadcasts, Experience Composer, and Live Captions.
Post-Call Transcriptions
Vonage Video API servers generate post-call transcriptions using artificial intelligence and other state-of-the-art technology.
Client observability
Use the Vonage Video Client SDK Client Observability API to monitor real-time metrics across both sender and receiver.
Moderation
Remove clients, force them to stop publishing a stream, or mute a stream's audio.
Signaling
Sending text and data to other clients in the session.
Audio fallback
Prioritize audio in response to network quality.
Archiving
Lets you record, save, and retrieve Vonage Video API sessions.
Broadcast
Share your Vonage Video API sessions with large audiences.
Audio Connector
Send audio from a Vonage Video API session to a WebSocket.
SIP Interconnect
Connect a Vonage Video API session to your SIP gateway.
Video Connector transport for Pipecat
Learn how to use Vonage Video Connector transport for Pipecat to build AI-powered applications.
Video Connector
Programmatically participate in Vonage Video API sessions as a server-side WebRTC participant with the ability to publish and subscribe to audio and video streams.
Voice
Optimizations for voice-only sessions.
End-to-End Encryption
Encrypt media being sent through a media server from your application.
Allowed IP list
The allowed IP list feature lets projects using the Enterprise environment know IP addresses of Vonage Video API servers.

Additional Resources


A Smarter, Safer Video API
A narrative overview of smart, self-optimizing Video API features — with complete settings recipes for common use cases.
Insights API
Programatically obtaining metadata about your video calls
Video codecs
Information on video codecs supported in the Vonage Video API
Scalable video
Improve the quality of video in multi-party sessions
Single Peer Connection
Multiplex all subscriber streams over a single peer connection to reduce network overhead, improve bandwidth management, and support better scalability.
Mobile guidelines
Considerations when developing for a mobile device
1080p video
Considerations on using 1080p video streams
Server rotation and session migration
Best practices for handling Video API server rotations and having clients automatically stay connected when they occur
Handling exceptions
Important information on handling exceptions, including errors when connecting to a session or publishing
Debugging during development
Tips for building your app
Security
Considerations when developing secure Vonage Video API apps
Restricted Network Guidelines
A decision tree for deploying a Vonage Video API client in a restricted network
Account management
Managing multiple projects in your Vonage Video API account
Configurable TURN servers
Configure the TURN servers used by Vonage Video API clients
Regional Media Zones
Restrict Vonage Video API media traffic to use media servers hosted inside a specific regional zone.
IP Proxy
Use your own proxy server to route non-media traffic—such as Video API calls, WebSocket connections, and log traffic—within a highly restrictive network environment.
EU Proxy
Use the Vonage Video EU proxy server to route all non-media traffic—such as Video API calls, WebSocket connections, and log traffic—within the EU.
China Relay
DEPRECATED Use the Vonage Video China Relay to route all non-media traffic—such as Video API calls, WebSocket connections, and log traffic—within China.
Advanced media stream encryption
Using AES-256 encryption of media streams