Nexmo Account API

Name: Account API
Brand: Vonage Account API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentFinanceBankingbasic8 EndpointsREST

Install Jentic One Beta

Connect the Account API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Account 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.

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 | sh

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 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 Account API.

Check the current credit balance on a Vonage account before launching a messaging campaign

Top up the Vonage account balance from a stored auto-reload account to keep SMS and voice traffic flowing

Rotate API secrets attached to a Vonage account API key for credential hygiene

GET STARTED

Start building with Account API

Explore with Jentic

View OpenAPI Document

For Agents

Read Vonage account balance, top up credit, manage API secrets, and configure default SMS and DLR callback URLs across a Vonage account.

Use for: I want to check my Vonage account balance, Top up my Vonage credit from the linked auto-reload account, Rotate the API secret on my Vonage API key, List all secrets attached to my Vonage account

Not supported: Does not handle SMS sending, voice calls, number provisioning, or verification flows — use for Vonage account balance, callback configuration, and API secret management only.

Use Cases

Patterns agents use Account API for, with concrete tasks.

★ Pre-flight balance check before bulk SMS

Before launching a high-volume SMS campaign, an operations workflow needs to confirm there is enough Vonage credit to cover the send. The Account API exposes GET /account/get-balance which returns the current balance and auto-reload status in a single call, so a pipeline can short-circuit a campaign that would otherwise fail mid-send. Implementation is a few hours including alert wiring.

Call GET /account/get-balance and abort the campaign if the returned value is below 50.00 EUR.

Scheduled API secret rotation

Security policy often requires rotating outbound API secrets every 90 days. The Account API exposes POST /accounts/{api_key}/secrets to mint a new secret and DELETE /accounts/{api_key}/secrets/{secret_id} to revoke an old one. A scheduled job can rotate without downtime by creating the new secret first, switching consumers, then revoking the old one. Effort is one afternoon for the cron and audit logging.

Create a new secret on api_key abc123, update the credential vault, then delete the previous secret_id once traffic has moved over.

Configure inbound SMS webhook

When standing up a new inbound SMS handler, the account-level callback URL must point at the new endpoint. POST /account/settings accepts a moCallBackUrl and drCallBackUrl that Vonage will invoke for inbound messages and delivery receipts. Setting these once at account scope avoids reconfiguring per-number. Roughly 30 minutes of work.

Update moCallBackUrl to https://app.example.com/vonage/sms and drCallBackUrl to https://app.example.com/vonage/dlr.

Agent-driven account top-up

An AI ops agent monitoring messaging spend needs to refill credit when balance dips below a floor. Through Jentic, the agent searches for 'top up vonage account', loads the POST /account/top-up schema, and executes the call with a stored trx reference. The agent never holds the API secret directly — Jentic injects credentials from the vault at execution time.

Search Jentic for 'top up vonage account', load the schema, then execute POST /account/top-up with the configured auto-reload trx reference.

Key Endpoints

8 endpoints — the vonage account api (account-api) lets you manage a vonage (formerly nexmo) communications account programmatically.

METHOD

PATH

DESCRIPTION

GET

/account/get-balance

Get the current account credit balance

POST

/account/top-up

Top up the account from the linked auto-reload account

POST

/account/settings

Update default SMS and DLR callback URLs

GET

/accounts/{api_key}/secrets

List API secrets for a key

POST

/accounts/{api_key}/secrets

Create a new API secret

DELETE

/accounts/{api_key}/secrets/{secret_id}

Revoke an API secret

POST

/account/register-sender

GET

/account/get-balance

Get the current account credit balance

POST

/account/top-up

Top up the account from the linked auto-reload account

POST

/account/settings

Update default SMS and DLR callback URLs

GET

/accounts/{api_key}/secrets

List API secrets for a key

POST

/accounts/{api_key}/secrets

Create a new API secret

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Vonage uses HTTP Basic auth with API key and API secret. Jentic stores both in the encrypted MAXsystem vault and injects them per call. The agent never sees the raw secret and credentials are scoped per workflow.

Intent-based discovery

Agents search by intent (e.g. 'check my Vonage account balance') and Jentic returns the matching Vonage operation with its input schema, so the agent calls the right endpoint without browsing developer.vonage.com.

Time to first call

Direct integration: 1-2 days for Basic auth, error handling, and balance checks. Through Jentic: under 30 minutes — search, load schema, execute.

FAQs

Specific to using Account API through Jentic.

What authentication does the Vonage Account API use?

It uses HTTP Basic authentication with the Vonage API key and API secret. Jentic stores both in the encrypted MAXsystem vault and injects them per request, so the agent never sees the raw secret in its context.

Can I rotate API secrets through the Vonage Account API?

Yes. POST /accounts/{api_key}/secrets creates a new secret and DELETE /accounts/{api_key}/secrets/{secret_id} revokes an old one. Vonage allows up to two active secrets per key so you can roll without downtime.

What are the rate limits for the Vonage Account API?

Vonage does not publish a hard request-per-second cap for the Account API in the spec. Account-level operations are typically low frequency; treat balance checks as eventual and avoid polling more than once per minute per key.

How do I check my Vonage balance through Jentic with the Vonage Account API?

Run pip install jentic, then search Jentic for 'check vonage account balance'. Jentic returns the GET /account/get-balance operation, you load its schema, and execute it. Credentials are pulled from the Jentic vault at call time.

Can I update the SMS callback URL with the Vonage Account API?

Yes. POST /account/settings accepts moCallBackUrl for inbound SMS and drCallBackUrl for delivery receipts. These are account-wide defaults and apply unless overridden at number or application scope.

Is the Vonage Account API free to use?

The endpoints themselves are free; you only pay for the underlying Vonage usage they manage (SMS, voice, verification credit). Top-up amounts are billed against your linked payment method via the auto-reload trx reference.

Nexmo Account API

Connect the Account API to your agent

Capabilities

Start building with Account API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs