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 Video API Archives API

Record sessions as composed or individual-stream archives.

Vonage Video API Archives API is one of 9 APIs that Vonage Video API publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Archives. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 5 paths, and defines 5 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

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

7 operations 5 paths 5 schemas 1 DELETE2 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://video.api.vonage.com/v2
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

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

  • bearerAuth — A JWT generated from your Vonage application's private key and application ID, sent in the Authorization header.

Paths & Operations 7

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

Archives 7

Record sessions as composed or individual-stream archives.

GET
/project/{applicationId}/archive
List archives for a project
listArchives 4 params → 200403
POST
/project/{applicationId}/archive
Start an archive (recording)
startArchive 1 param body → 200403409
GET
/project/{applicationId}/archive/{archiveId}
Get an archive
getArchive 2 params → 200404
DELETE
/project/{applicationId}/archive/{archiveId}
Delete an archive
deleteArchive 2 params → 204403409
POST
/project/{applicationId}/archive/{archiveId}/stop
Stop an archive
stopArchive 2 params → 200409
PUT
/project/{applicationId}/archive/{archiveId}/layout
Change the layout of a composed archive
setArchiveLayout 2 params body → 200403
PATCH
/project/{applicationId}/archive/{archiveId}/streams
Add or remove streams from a composed archive
selectArchiveStreams 2 params body → 204403

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Archive (13 properties), StartArchiveRequest (9 properties), StreamSelectionRequest (4 properties), Layout (3 properties). Each schema is shown below with its type and property counts.

Archive
object
13 properties
StreamSelectionRequest
object
4 properties
ArchiveList
object
2 properties
Layout
object
3 properties
StartArchiveRequest
object
9 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vonage-video-archives-api-openapi.yml Raw ↑

Other APIs Vonage Video API publishes across the network.

Vonage Video API Broadcasts API
Vonage Video API Captions API
Vonage Video API Moderation API
Vonage Video API Render API
Vonage Video API Sessions API
Vonage Video API Signaling API
Vonage Video API SIP API
Vonage Video API Streams API
Where this information came from

This is an independent, third-party profile of Vonage Video API Archives 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.