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 Record API

The record API from Vonage — 1 operation(s) for record.

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

This API exposes 1 operation across 1 path, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 5.5.1.

Requests are made against a single base URL, https://api.nexmo.com/v1.

1 operations 1 paths 9 schemas 1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
5.5.1
Base URL
https://api.nexmo.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Record 1
PUT
/conversations/{conversation_id}/record
Start or stop a conversation recording
recordConversation 1 param body → 200400401404500

Schemas 9

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

format
string
Record the Conversation in a specific format.
transcription
object
Options to transcribe the recording into text.
4 properties
conversation_error_not_found
object
Conversation not found
5 properties
event_url
array
The webhook endpoint where recording progress events are sent to.
timeout
integer
The maximum duration of the recording in seconds.
event_method
string
The HTTP method used to send event information to eventurl.
split
string
Record the sent and received audio in separate channels of a stereo recording
retention_ttl
integer
The total number of days the recording will be stored for.
action
string
Recording Action

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vonage-record-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 Record 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.