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 Experience Composer API

APIs relating to Experience Composer

Vonage Experience Composer 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 Experience Composer. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 74 JSON Schemas.

This API exposes 4 operations across 2 paths, and defines 10 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.

4 operations 2 paths 10 schemas 1 DELETE2 GET1 POST

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 Experience Composer 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 4

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

Experience Composer 4

APIs relating to Experience Composer

POST
/v2/project/{application_id}/render
Start an Experience Composer Session
start-experience-composer-session 1 param body → 202400403429
GET
/v2/project/{application_id}/render
List all experience composers in an application
get-experience-composers-in-application 3 params → 200403
GET
/v2/project/{application_id}/render/{experience_composer_id}
Get an Experience Composer Session
get-experience-composer-session 2 params → 200400403404
DELETE
/v2/project/{application_id}/render/{experience_composer_id}
Stop an Experience Composer
stop-experience-composer 2 params → 204400403404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Experience-Composer-Base (11 properties), Start-Experience-Composer (6 properties), Video-Error (2 properties). Each schema is shown below with its type and property counts.

Start-Experience-Composer
object
6 properties
Experience-Composer-Name
string
The name of the composed output stream which is published to the session.
Experience-Composer
Session-ID
string
The session ID of the Vonage Video session you are working with
Resolution
string
The resolution of the archive, either "640x480" (SD landscape, the default), "1280x720" (HD landscape), "1920x1080" (FHD landscape), "480x640" (SD portrait), "…
Experience-Composer-URL
string
A publicly reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention.
Token
string
A valid OpenTok JWT token with a Publisher role and (optionally) connection data to be associated with the output stream.
Experience-Composer-Base
object
11 properties
ApplicationID
string
A Vonage Application ID
Video-Error
object
Error thrown in the Vonage Video API
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vonage-experience-composer-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 Broadcast API
Vonage Calls API
Vonage Configuration API
Vonage Conversation API
Where this information came from

This is an independent, third-party profile of Vonage Experience Composer 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.