canonical: https://jentic.com/apis/voxloud.com/voxloud

# Voxloud API

Cloud telephony and contact management API for Voxloud (Voverc). The API exposes 19 endpoints secured with apiKey authentication.

## For AI agents

Programmatically create a new contact, search and list contacts. Covers 19 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or developer tools - use for crm only.

## Capabilities

- Create a new contact
- Search and list contacts
- Get contact by ID
- Update contact
- Delete contact
- Retrieve all users

## Use cases

### CRM Operations

Use the Voxloud API to perform crm operations programmatically. The API provides 19 endpoints covering core functionality including create a new contact, search and list contacts, get contact by id.

Example prompt: Call POST /contacts to create a new contact

### Automated Authentication Management

Automate authentication operations by combining multiple Voxloud API endpoints. Agents can search and list contacts and then get contact by id in a single workflow.

Example prompt: Call GET /contacts to search and list contacts, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Voxloud API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'create a new contact', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/contacts` | Create a new contact |
| GET | `/contacts` | Search and list contacts |
| GET | `/contacts/{id}` | Get contact by ID |
| PUT | `/contacts/{id}` | Update contact |
| DELETE | `/contacts/{id}` | Delete contact |
| GET | `/users` | Retrieve all users |
| POST | `/webhook-subscriptions` | Create webhook subscription |
| GET | `/webhook-subscriptions` | List all webhook subscriptions |

## Key resources

- **Authentication** — Operations related to Authentication
- **Click-to-Call** — Operations related to Click-to-Call
- **Contacts** — Operations related to Contacts
- **Telephony** — Operations related to Telephony
- **Users** — Operations related to Users

## AI readiness

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.

- **Score:** 63 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 59 / 100
  - AI-Readiness & Agent Experience: 47 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 66 / 100
- **View full report:** https://jentic.com/apis/voxloud.com/voxloud/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

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

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring Voxloud by hand means setting its Voverc-Auth key header, choosing the v1 or v2 host on developer.voxloud.com, and managing the contact and webhook calls yourself. Through Jentic you install once, import Voxloud from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Voxloud puts the contact id in the URL path (`/contacts/{id}`), so a rule can pin your agent to reading one contact. You choose the operations it may call, so destructive ones like contact deletion are not included unless you add them.
- **Credential handling:** Your Voxloud API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a contact' or 'subscribe a webhook', and Jentic returns the matching Voxloud operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the Voxloud API use?

The Voxloud API uses an API key passed in the `Voverc-Auth` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I create a new contact with the Voxloud API?

Yes. Use the POST /contacts endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Voxloud API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I create a new contact through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create a new contact'. Jentic returns the matching Voxloud API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Voxloud API have?

The Voxloud API exposes 19 endpoints covering authentication, click-to-call, contacts operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Voxloud operations and credentials the agent may use. Since Voxloud puts the contact id in the URL path (`/contacts/{id}`), you can pin the agent to reading a single contact, and you choose exactly which endpoints it may call. Destructive operations such as DELETE `/contacts/{id}` stay out of reach unless you explicitly add them.