canonical: https://jentic.com/apis/nexmo.com/vonage-application

# Nexmo Application API

The Vonage Application API V1 (application) provides CRUD operations for Vonage Applications, the container resource that binds voice answer URLs, event callback URLs, and assigned virtual numbers. This V1 surface is deprecated by Vonage in favour of v2 at /v2/applications, but remains useful for inventory and migration. The 5 endpoints cover list, create, retrieve, update, and delete on the application resource.

## For AI agents

Manage legacy Vonage V1 applications - list, create, update, and delete the application objects that route voice calls and webhook events.

## Scope

Does not place calls, send SMS, provision numbers, or generate JWTs - use for Vonage V1 application object lifecycle only.

## Capabilities

- List all Vonage applications registered against an account for inventory and audit
- Create a new Vonage application that bundles voice answer and event webhook URLs
- Retrieve a single application's webhook configuration before routing inbound calls
- Update an existing application's voice or event callback URLs without recreating it
- Delete a deprecated application once its virtual numbers have been migrated off

## Use cases

### Inventory existing applications before v2 migration

Vonage Applications V1 is deprecated and v2 is the supported version. Before migrating, an operator needs a full list of v1 applications and their webhook URLs to plan recreation in v2. GET / returns paginated applications with answer_url, event_url, and assigned numbers, allowing a migration script to replay them against the v2 endpoint. Effort is roughly half a day including webhook validation.

Example prompt: Call GET / to enumerate all v1 applications and write each one's name, answer_url, and event_url to a migration manifest.

### Update webhook URL after a backend redeploy

When the answer or event handler is redeployed at a new URL, every affected Vonage application needs its callback URLs updated. PUT /{app_id} accepts new answer_url and event_url values without disturbing the application's private key or assigned numbers. A small script can sweep all affected app_ids in minutes.

Example prompt: PUT /{app_id} for each impacted application_id, replacing answer_url with https://api.example.com/voice/answer.

### Decommission deprecated v1 application

Once a v1 application has been replaced by a v2 equivalent and no numbers remain assigned, it should be deleted to keep the inventory clean. DELETE /{app_id} removes the application; numbers must be unassigned first via the Numbers API. A few minutes per application.

Example prompt: DELETE /{app_id} on the legacy v1 application after confirming no numbers are still bound.

### Agent-driven application provisioning

An AI agent provisioning a new tenant needs to create a Vonage application with the correct webhook URLs. Through Jentic, the agent searches for 'create a vonage application', loads the POST / schema, and executes with the tenant-specific URLs. Credentials stay in your Jentic One instance.

Example prompt: Search Jentic for 'create a vonage application', load schema, and POST / with name, answer_url, and event_url for the new tenant.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | / | List all applications |
| POST | / | Create an application |
| GET | /{app_id} | Retrieve an application |
| PUT | /{app_id} | Update an application |
| DELETE | /{app_id} | Delete an application |

## Key resources

- **Applications** — List, create, retrieve, update, and delete Vonage Applications V1 (deprecated).

## Why Jentic

- **Setup:** Wiring the Nexmo Application API by hand means supplying your Vonage key and secret on each call, pointing at the v1/applications host, and managing the application object lifecycle yourself. Through Jentic you install once, import the Nexmo Application API from the API Directory, store the key and secret once, and your agent calls it.
- **Permission scoping:** This API puts the application id in the URL path (/{app_id}), so a rule can pin your agent to one application: it can read and update that application and nothing else. You choose the operations it may call, so application creation and deletion are not included unless you add them.
- **Credential handling:** Your Vonage API key and secret are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list Vonage applications' or 'update an application', and Jentic returns the matching Nexmo Application API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Vonage Voice API** — Vonage's voice calling API tied to Vonage applications.
- **Vonage Numbers API** — Vonage's virtual phone number provisioning API.
- **Vonage Messages API** — Vonage's omnichannel messaging API for SMS, MMS, WhatsApp, Viber, and Facebook Messenger.
- **Twilio Accounts API** — Twilio's account and subaccount management API.
- **Plivo API** — Plivo's SMS, voice, and account management platform.

## FAQ

### What authentication does the Vonage Application API V1 use?

The OpenAPI spec for Applications V1 does not declare an auth scheme, but in production Vonage requires the API key and secret as query parameters. Jentic stores both in the encrypted Jentic One instance and appends them at call time.

### Should I use the Vonage Application API V1 or the v2 Application API?

Vonage marks Applications V1 as deprecated and recommends the v2 Application API at /v2/applications. Use v1 only to inventory or decommission existing applications; create new applications on v2.

### What are the rate limits for the Vonage Application API V1?

Application management is a low-frequency control-plane operation. Vonage does not publish a documented per-second cap for these endpoints in the spec; treat list operations as eventually consistent and avoid tight polling loops.

### How do I list applications through Jentic with the Vonage Application API V1?

Install the SDK with pip install jentic, search Jentic for 'list vonage applications', load the GET / schema, and execute. Jentic injects the API key and secret from the vault at call time.

### Can I update an application's answer_url with the Vonage Application API V1?

Yes. PUT /{app_id} accepts new answer_url and event_url values; the application's private key and number assignments are preserved. Run it through Jentic One, the self-hosted execution layer, to manage Vonage Applications.

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

Yes. Jentic One is self-hosted, so your own rules decide which of the five operations your agent may call and which credentials it may use. Because the application id sits in the URL path, you can pin the agent to a single application so it only reads (GET /{app_id}) and updates (PUT /{app_id}) that one, and you leave listing (GET /), creation (POST /), and deletion (DELETE /{app_id}) out of scope unless you explicitly add them. Your Vonage API key and secret stay in your own instance and are injected only for the operations you permit.