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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Vonage

Vonage Archives API

APIs relating to working with archives

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 7 operations across 5 paths, and defines 19 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.

7 operations 5 paths 19 schemas 1 DELETE2 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
Contact
Vonage DevRel
Resource Areas
1

Authentication & Security 1

Vonage Archives 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 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

APIs relating to working with archives

GET
/v2/project/{application_id}/archive
List all archives in an application
get-v2-project-application_id-archive 4 params → 200403
POST
/v2/project/{application_id}/archive
Create a new archive
post-v2-project-application_id-archive 1 param body → 200400403404409
GET
/v2/project/{application_id}/archive/{archive_id}
Return archive information for specific archive
get-archive-information 2 params → 200400403
DELETE
/v2/project/{application_id}/archive/{archive_id}
Delete an archive
delete-v2-project-application_id-archive-archive_id 2 params → 204403409
PATCH
/v2/project/{application_id}/archive/{archive_id}/streams
Add or remove a stream from an archive
patch-v2-project-application_id-archive-archive_id-streams 2 params body → 204400403404
POST
/v2/project/{application_id}/archive/{archive_id}/stop
Stop an archive
stop-archive 2 params → 200400403404409
PUT
/v2/project/{application_id}/archive/{archive_id}/layout
Change the layout of an archive
put-v2-project-application_id-archive-archive_id-layout 2 params body → 200400403

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Archive-Detail (20 properties), Transcription (5 properties), Add-Stream-To-Archive (3 properties), Layout (3 properties). Each schema is shown below with its type and property counts.

Add-Stream-To-Archive
object
3 properties 1 required
Resolution
string
The resolution of the archive, either "640x480" (SD landscape, the default), "1280x720" (HD landscape), "1920x1080" (FHD landscape), "480x640" (SD portrait), "…
Transcription-Properties
object
2 properties
Archive-Name
string
The name of the archive (for your own identification)
Stream-Mode
string
Whether streams included in the archive are selected automatically ("auto", the default) or manually ("manual"). When streams are selected automatically ("auto…
Has-Video
boolean
Whether the archive will record video (true, the default) or not (false). If you set both hasAudio and hasVideo to false, the call to this method results in an…
Has-Transcription
boolean
Whether the archive will have a transcription of the audio of the session (true) or not (false, the default).
ApplicationID
string
A Vonage Application ID
Has-Audio
boolean
Whether the archive will record audio (true, the default) or not (false). If you set both hasAudio and hasVideo to false, the call to this method results in an…
Session-ID
string
The session ID of the Vonage Video session you are working with
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…
Quantization-Parameter
number
Quantization parameter (QP) is an optional video encoding value allowed for composed archives. Smaller values generate higher quality and larger archives, and…
MultiArchiveTag
string
Set this to support recording multiple archives for the same session simultaneously. Set this to a unique string for each simultaneous archive of an ongoing se…
Archive-Detail
object
20 properties
OutputMode
string
Whether all streams in the archive are recorded to a single file ("composed", the default) or to individual files ("individual").
Video-Error
object
Error thrown in the Vonage Video API
2 properties
Remove-Stream-From-Archive
object
1 property 1 required
Transcription
object
Properties of the transcription attached to this archive
5 properties 1 required
Layout
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vonage-archives-api-openapi.yml Raw ↑

Other APIs Vonage publishes across the network.

Vonage Account API
AE Profile APIs.io
Vonage Advanced API
AE Profile APIs.io
Vonage Application API
AE Profile APIs.io
Vonage Applications API
AE Profile APIs.io
Vonage Audio Connector API
AE Profile APIs.io
Vonage Balance API
AE Profile APIs.io
Vonage Basic API
AE Profile APIs.io
Vonage Broadcast API
AE Profile APIs.io
Vonage Calls API
AE Profile APIs.io
Vonage Configuration API
AE Profile APIs.io
Vonage Conversation API
AE Profile APIs.io
Vonage Dial In Numbers API
AE Profile APIs.io
#Archives
← Back to V APIs
API Details
ID
vonage:vonage-archives-api
Base URL
https://video.api.vonage.com
Docs
https://developer.vonage.com/en/api/sms
Provider
Vonage
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=vonage-archives-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vonage-archives-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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