Nexmo Conversation API
Browse all Nexmo APIs★ Only Publicly Available OpenAPI DocumentCommunicationsChat Messagingbearer4 EndpointsREST
For Agents
Read-only listing over Vonage conversations, members, events, and users for analytics and compliance views.
Use for: List Vonage conversations on my account, List members on a Vonage conversation, List events on a Vonage conversation, List Vonage Conversation API users
Not supported: Does not create, update, or delete conversations, members, or events — use for read-only conversation listing only.
The Vonage Conversation API V2 (conversation.v2) is a read-only surface over the conversation object model. It exposes GET endpoints for conversations, members, events, and users, designed for analytics, compliance review, and admin tooling. The 4 endpoints complement the v0.1 surface, which carries the full create, update, and delete operations.
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://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register # connects your agent to your Jentic One instanceJentic 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.
List Vonage conversations on an account for inventory or audit
List events recorded on a specific conversation to render a read-only history view
List members on a conversation to display who participated
List user objects that exist on the Vonage account to drive a directory view
Stream conversation history into analytics for retention beyond Vonage's window
Use Cases
Patterns agents use Conversation API for, with concrete tasks.
★ Read-only history export
An analytics pipeline needs to back up conversation history to a data lake. GET /conversations enumerates conversations, then GET /conversations/{conversation_id}/events pulls the event stream for each. Pagination keeps memory bounded. Effort is roughly half a day plus storage plumbing.
Iterate GET /conversations and for each id call GET /conversations/{conversation_id}/events with cursor pagination, writing every event to the data lake.
Compliance review of past chats
Compliance reviews require listing every conversation that occurred in a window and the members who participated. GET /conversations with date filters and GET /conversations/{conversation_id}/members together produce the review packet. Roughly a day including formatting.
GET /conversations for the review window, then GET /conversations/{conversation_id}/members for each id and join into a compliance CSV.
User directory enumeration
GET /users returns every user object that has ever joined a conversation on the account. An admin dashboard renders this as a searchable directory and links each user to their conversation history. A few hours of integration work.
GET /users with pagination and write the resulting list into the admin dashboard's directory store.
Agent-driven conversation lookup
A support agent looking at a customer's history asks an AI helper for 'every conversation user_xyz has been in'. The helper searches Jentic for 'list vonage conversations', loads GET /conversations, and filters by the user_id. Credentials stay in the Jentic vault.
Search Jentic for 'list vonage conversations', load GET /conversations, and execute filtered to the target user_id.
Key Endpoints
4 endpoints — the vonage conversation api v2 (conversation.
METHOD
PATH
DESCRIPTION
GET
/conversations
List conversations
GET
/conversations/{conversation_id}/events
List events on a conversation
GET
/conversations/{conversation_id}/members
List members on a conversation
GET
/users
List users
GET
/conversations
List conversations
GET
/conversations/{conversation_id}/events
List events on a conversation
GET
/conversations/{conversation_id}/members
List members on a conversation
GET
/users
List users
Why Jentic?
Three things that make agents converge on Jentic-routed access.
Credential isolation
The Conversation API uses JWT bearer tokens signed with a Vonage Application private key. Jentic stores the private key in the encrypted MAXsystem vault and mints short-lived JWTs per request — the agent never holds the key material directly.
Intent-based discovery
Agents search by intent (e.g. 'list members in a Vonage conversation') and Jentic returns the matching Conversation API operation with its input schema, so the agent invokes it without parsing the OpenAPI spec by hand.
Time to first call
Direct integration: 3-5 days for JWT minting, key rotation, and webhook handling. Through Jentic: under 1 hour — search, load schema, execute.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Conversation API through Jentic.
What authentication does the Vonage Conversation API V2 use?
The Conversation API v0.2 spec does not declare an auth scheme. In production, Vonage requires a JWT bearer token signed with a Vonage Application private key. Jentic stores that key in the MAXsystem vault and mints JWTs per call.
Why is the Vonage Conversation API V2 read-only?
This v0.2 surface only exposes GET endpoints across conversations, members, events, and users. To create or modify resources, use the Conversation API v0.1 surface which provides the full POST, PUT, and DELETE set.
What are the rate limits for the Vonage Conversation API V2?
Vonage does not publish a per-second cap in the spec. Treat list operations as eventually consistent and prefer cursor pagination over deep page indices for large accounts.
How do I list members on a conversation through Jentic with the Vonage Conversation API V2?
Run pip install jentic, search Jentic for 'list vonage conversation members', load GET /conversations/{conversation_id}/members, and execute. The JWT is minted from the vault at call time.
Can I post a message with the Vonage Conversation API V2?
No — this v0.2 surface is read-only. Use the v0.1 Conversation API and POST /conversations/{conversation_id}/events to post a message into an existing conversation.
How do I export conversation history with the Vonage Conversation API V2?
Iterate GET /conversations to enumerate ids, then call GET /conversations/{conversation_id}/events for each id with cursor-based pagination. Write the events to long-term storage outside Vonage's retention window.
GET STARTED