Jentic OSThe workplace. An in-house AI platform for every employeeJentic OneSafe access. Agents reach your systems without holding keysJentic AIRThe foundation. Gets your existing platforms ready for AI
Pricing

GET STARTED

API DirectoryBrowse 10,000+ APIs ready for AI agent integrationDocumentationGuides and API reference

TOOLS

API ScoringCheck your AI readiness using our scorecardArazzo UIVisualize Arazzo workflows as interactive documentationArazzo EditorBuild and edit multi-step API workflows visually

COMMUNITY

GitHubOpen source projects and examplesOpen StandardsBuilt on open specs. Never locked in.
All ResourcesEverything in one placeBlogLatest articles and insightsTech Talk NewsletterAPIs, AI agents, architecture and strategyWebinarsLive sessions and on-demand recordingsReports & WhitepapersOriginal research on enterprise AI
About UsOur mission and teamCareersJoin our teamContactGet in touch
Try it now
Jentic OSJentic OneJentic AIR
Pricing
API DirectoryDocumentationAPI ScoringArazzo UIArazzo EditorGitHubOpen Standards
All ResourcesBlogTech Talk NewsletterWebinarsReports & Whitepapers
About UsCareersContact
Try it now
JenticJentic
Products
  • Jentic OS
  • Jentic One
  • Jentic AIR
For Developers
  • API Directory
  • Documentation
  • GitHub
Company
  • About Jentic
  • Careers
  • Contact Us
  • Trust Centre
ISO/IEC 27001:2022 certification badge issued by Prescient SecurityISO/IEC 27001:2022 certification badge issued by Prescient Security

Information Security Management System

Certified to ISO/IEC 27001:2022 by Prescient Security

AICPA SOC for Service Organizations logoAICPA SOC for Service Organizations logo

SOC 2® Type 1 report

Audited by Prescient Assurance

Terms & Conditions•Privacy Policy•
© 2026 Jentic Technology Ltd. All rights reserved.
2 Grattan Court East, Dublin, D02 VX86, Ireland
Switch to light modeSwitch to dark mode
APIs / Communications / Nexmo / Conversation API
Conversation API logo

Nexmo Conversation API

Browse all Nexmo APIs
72
AI ReadinessAI-Aware (A-)72/100
See full scorecard
Community OpenAPI document · agent-readyCommunicationsChat Messagingbearer23 EndpointsREST

Know of an official OpenAPI document? Contribute it →

For Agents

Build multi-party chat, voice, SMS, and WebRTC conversations with shared persisted history across 23 endpoints.

Use for: Create a new Vonage conversation, Add a member to a Vonage conversation, Post a message event to a Vonage conversation, List members in a Vonage conversation

Not supported: Does not send standalone SMS, place outbound calls, or provision numbers - use for multi-party persisted conversation orchestration only.

The Vonage Conversation API (conversation-api) lets you build multi-party communication features that span IP messaging, PSTN voice, SMS, and WebRTC audio and video on a single shared conversation object. Conversation content is persisted, allowing playback or pickup later. The 23 endpoints cover conversations, members, events, users, legs, and call recording - enough surface to power in-app chat, recorded sales calls, agent-routed support threads, and omnichannel customer experiences.

Jentic One on GithubView OpenAPI Document

Install Jentic One Beta

Connect the Conversation API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Conversation API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

1

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fnexmo.com%2Fvonage-conversation-api" | sh
2

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fnexmo.com%2Fvonage-conversation-api" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Conversation API.

Create a Vonage conversation that scopes a multi-party message and event stream

Add and remove members on a conversation to control who can post and receive events

Post events into a conversation to drive in-app chat, custom signalling, or media uploads

List events on a conversation to render the message history in a client

Manage user accounts that participate in conversations across IP messaging, PSTN, SMS, and WebRTC

Trigger and stop call recording on an active conversation for later playback or transcription

Use Cases

Patterns agents use Conversation API for, with concrete tasks.

★ In-app customer support chat

A support web app needs persistent chat threads where customers and agents exchange text and image events. POST /conversations creates the thread, POST /conversations/{conversation_id}/members adds participants, and POST /conversations/{conversation_id}/events streams in messages. Clients render history via GET /conversations/{conversation_id}/events. End-to-end build is roughly a week including auth and UI.

POST /conversations with name 'support-thread-1234', then POST /conversations/{conversation_id}/members for both customer and agent user_ids.

Recorded sales call with transcription

Sales teams record calls for compliance and downstream transcription. Once a Conversation is bound to a call, PUT /conversations/{conversation_id}/record starts and stops recording. Playback URLs flow into the existing analytics pipeline. Implementation is one afternoon plus webhook plumbing.

PUT /conversations/{conversation_id}/record with action 'start' and split: 'conversation' to capture all participants on one stream.

User-scoped conversation listing

When a user logs into a chat client, their inbox is the list of conversations they participate in. GET /users/{user_id}/conversations returns that list with last activity metadata so the client can render the inbox in one round trip. Pagination keeps payloads manageable for power users.

GET /users/{user_id}/conversations with page_size 50 and render the result as the inbox.

Member moderation on policy violation

When a chat moderation system flags a message, it must remove the offending member from the thread. DELETE /conversations/{conversation_id}/members/{member_id} ejects the member; subsequent posts from them will be rejected. The full lifecycle including audit logging takes a few hours.

DELETE /conversations/{conversation_id}/members/{member_id} for the offending member and post a system event noting the moderation.

Agent-driven conversation orchestration

An AI agent running a virtual team standup creates a conversation, adds each team member as a user, and posts a daily prompt event. Through Jentic, the agent searches for 'create vonage conversation', loads POST /conversations, and chains member and event creation calls - credentials stay in your Jentic One instance.

Search Jentic for 'create vonage conversation', load schema, POST /conversations, then loop POST /conversations/{conversation_id}/members and POST /conversations/{conversation_id}/events for the standup prompt.

Key Endpoints

23 endpoints — the vonage conversation api (conversation-api) lets you build multi-party communication features that span ip messaging, pstn voice, sms, and webrtc audio and video on a single shared conversation object.

METHOD

PATH

DESCRIPTION

POST

/conversations

Create a conversation

GET

/conversations

List conversations

POST

/conversations/{conversation_id}/members

Add a member to a conversation

POST

/conversations/{conversation_id}/events

Post an event to a conversation

GET

/conversations/{conversation_id}/events

List events in a conversation

PUT

/conversations/{conversation_id}/record

Start or stop conversation recording

GET

/users/{user_id}/conversations

List conversations a user belongs to

POST

/users

Create a user

POST

/conversations

Create a conversation

GET

/conversations

List conversations

POST

/conversations/{conversation_id}/members

Add a member to a conversation

POST

/conversations/{conversation_id}/events

Post an event to a conversation

GET

/conversations/{conversation_id}/events

List events in a conversation

PUT

/conversations/{conversation_id}/record

Start or stop conversation recording

GET

/users/{user_id}/conversations

List conversations a user belongs to

POST

/users

Create a user

Jentic AI Readiness Score

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

C

Conversation API

- AI-Aware (A-)
72/100
79
Foundational Compliance
65
Developer Experience & Jentic Compatibility
56
AI-Readiness & Agent Experience
94
Agent Usability
75
Security
100
AI Discoverability
Powered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
79

Foundational Compliance

Base layer of spec validity and structural soundness.

Grade: A-Signals: 4
98%

Lint Results

Aggregated quality score from linter diagnostics, weighted by severity.

100%

Resolution Completeness

Percentage of `$ref` references that resolve successfully.

100%

Specification Validity

Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).

17%

Structural Integrity

Structural correctness score based on schema issues using logarithmic dampening.

65

Developer Experience & Jentic Compatibility

Clarity, completeness, and ingestion readiness for developers and tooling.

Grade: BSignals: 4
39%

Example Density

How richly the API is illustrated with examples.

94%

Example Validity

Percentage of examples that conform to their schemas.

26%

Response Coverage

Percentage of operations with complete response definitions (success, client error, server error).

100%

Tooling Readiness

Health of API ingestion, bundling, and resolution within Jentic pipelines.

56

AI-Readiness & Agent Experience

Semantic breadth, depth, and agent comprehension for AI systems.

Grade: CSignals: 4
57%

Description Coverage

Coverage of descriptions across API elements.

0%

Error Standardization

Coverage of RFC 9457 Problem Details for error responses.

100%

OperationId Quality

Coverage, uniqueness, and casing consistency of operationIds for AI inference.

66%

Summary Coverage

Coverage of summaries across operations/tags/info.

94

Agent Usability

Functional utility, complexity comfort, and AI orchestration readiness.

Grade: A+Signals: 1
94%

Complexity Comfort

Agent comfort level based on API operational and structural complexity.

75

Security

Trust, risk posture, and security compliance.

Grade: A-Signals: 1
75%

Authentication Strength

Average quality of security schemes based on authentication method strength (weakest link for OAuth2).

100

AI Discoverability

Findability, semantic richness, and reasoning readiness.

Grade: A+Signals: 1
100%

Descriptive Richness

Clarity and depth of descriptions across API elements.

View full reportHow the score is calculatedMore about the dimensions

Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

Score your own APIScoring CLI agent skill
npx @jentic/api-scorecard-cli score <openapi-url>

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring the Vonage Conversation API by hand means minting JWT bearer tokens from your application private key, pointing at the v0.1 host, and threading conversation, member, and user ids across multi-party sessions yourself. Through Jentic you install once, import the Conversation API from the API Directory, store the application private key once, and your agent calls it.

Permission scoping

The Conversation API puts the conversation id in the URL path (/conversations/{conversation_id}/members), so a rule can pin your agent to one conversation: it can add members and post or read events for that conversation and nothing else. You choose the operations it may call, so creating conversations or users is not included unless you add it.

Credential isolation

Your Vonage application private key is stored once, encrypted, by your own Jentic One instance, which mints short-lived JWTs and injects the bearer token at execution time. The key material never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'add a member to a Vonage conversation' or 'post an event to a conversation', and Jentic returns the matching Conversation API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Twilio Conversations API

→

Twilio's omnichannel messaging conversation API.

Choose Twilio Conversations for cross-channel SMS, MMS, WhatsApp, and chat threads on the Twilio platform.

Alternative

Twilio Chat API

→

Twilio's in-app chat platform with channels and members.

Choose Twilio Chat when building in-app chat without telephony or SMS.

Complementary

Vonage Messages API

→

Vonage's omnichannel messaging API for SMS, MMS, WhatsApp, Viber, and Facebook Messenger.

Use after creating an Application to send messages bound to that application's credentials.

Complementary

Vonage Voice API

→

Vonage's voice calling API tied to Vonage applications.

Use alongside Application API to register the application that will place or receive calls.

Alternative

Plivo API

→

Plivo's SMS, voice, and account management platform.

Choose Plivo when an agent is already using Plivo for telephony or wants a Vonage alternative.

FAQs

Specific to using Conversation API through Jentic.

What authentication does the Vonage Conversation API use?

It uses JWT bearer tokens signed with a Vonage Application private key. Jentic stores the private key in the encrypted Jentic One instance and mints short-lived JWTs per request, so the agent never holds the raw key.

How are members different from users in the Vonage Conversation API?

A user is a long-lived account on POST /users that can participate in any conversation. A member is the per-conversation join created by POST /conversations/{conversation_id}/members and bound to a user_id. Removing a member does not delete the user.

What are the rate limits for the Vonage Conversation API?

Vonage does not publish a hard per-second cap in the OpenAPI spec for the Conversation API. Treat event posts as the highest-frequency endpoint and batch where possible - clients posting more than several events per second per conversation should rely on Vonage's client SDK to multiplex over a single websocket.

How do I post a message into a conversation through Jentic with the Vonage Conversation API?

Run pip install jentic, search Jentic for 'post vonage conversation event', load POST /conversations/{conversation_id}/events, and execute with type 'text' and a body containing the message text. JWTs are minted from the vault at call time.

Can I record a conversation with the Vonage Conversation API?

Yes. PUT /conversations/{conversation_id}/record accepts an action of 'start' or 'stop' and a split mode controlling whether each participant is captured on a separate stream or mixed.

How many channels does the Vonage Conversation API support?

The Conversation API spans IP messaging, PSTN voice, SMS, and WebRTC audio and video on the same conversation object. A single conversation can therefore carry events from any combination of those channels.

Can I limit what my agent is allowed to do with the Vonage Conversation API?

Yes. Because you self-host Jentic One, your own rules decide which Conversation API operations and credentials the agent may use, and you pick the exact endpoints it can call. Since the conversation id sits in the URL path, such as /conversations/{conversation_id}/members and /conversations/{conversation_id}/events, a rule can pin the agent to a single conversation so it only adds members and posts or reads events there. Broader operations like POST /conversations to create new threads or POST /users to create accounts stay off unless you explicitly grant them.

GET STARTED

Start building with Conversation API

Explore with Jentic One
View OpenAPI Document