Getting Started

Welcome to the V.cloud Version 4 API. This guide will walk you through the authentication requirements, key types, and how to send your first request to the preview environment.

What’s New in Version 4

• Fine-grained access control with role templates.
• Unified analytics endpoints with richer segmentation.
• Extended webhook payloads for full meeting lifecycle tracking.
• Enhanced security with stricter HMAC authentication.
• Comprehensive Webhook Management system for receiving real-time notifications about events occurring at the organization, project, or room level

Prerequisites

Before using the V.cloud V4 API, ensure you have:

• An active V.cloud organization.
• Your Organization API Key and Organization Secret Key
  (used only for the Projects endpoints).
• Your Project API Key and Project Secret Key
  (used for Rooms, Analytics, Webhooks, and all other REST endpoints).
• A tool such as Postman, Curl, or an HTTP client library.
• Basic understanding of JSON and RESTful APIs.

📥 Download Postman Collection

To get started quickly, download our pre-configured Postman collection:

After downloading, import the collection into Postman to start testing the API endpoints immediately.

Base URL

The production API endpoint is:

Authentication

V.cloud uses **HMAC SHA256 signature authentication (Base64-encoded) ** for all secure endpoints in V4.

import base64
import hmac, hashlib, requests, json

def generate_signature(message, secret):
    """
    Generate HMAC SHA256 signature.
    Returns:
        Base64 encoded signature
    """
    signature = hmac.new(
        secret.encode('utf-8'),
        message.encode('utf-8'),
        hashlib.sha256
    ).digest()
    return base64.b64encode(signature).decode('utf-8')

There are two different types of API credentials depending on the endpoint you are calling:

🔐 1. Organization API Key & Secret

Used only for:

• Managing Projects
• Listing projects
• Creating or deleting projects
• Updating project quotas/limits

🔐 2. Project API Key & Secret

Used for all other REST endpoints, including:

• Rooms (create, status, end)
• Analytics
• Recordings
• branding
• Webhooks