Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the The SureVoIP RESTful 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://jentic.com/install.sh?src=apis&api=%2Fapis%2Fsurevoip.co.uk%2Fthe-surevoip-restful-api" | shStep 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%2Fsurevoip.co.uk%2Fthe-surevoip-restful-api" | 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.
What an agent can do with The SureVoIP RESTful API.
List global resources
Add a new announcement audio file
Create phone calls with or without announcements and scheduled hangups
Validate a phone number by calling it once
Monitor The SureVoIP RESTful API operational status and events
GET STARTED
Patterns agents use The SureVoIP RESTful API for, with concrete tasks.
★ Productivity Operations
Use the The SureVoIP RESTful API to perform productivity operations programmatically. The API provides 28 endpoints covering core functionality including list global resources, add a new announcement audio file, list global announcements.
Call GET / to list global resources
Automated announcements Management
Automate announcements operations by combining multiple The SureVoIP RESTful API endpoints. Agents can add a new announcement audio file and then list global announcements in a single workflow.
Call POST /announcements to add a new announcement audio file, then verify the result
AI Agent Integration via Jentic
AI agents discover and call The SureVoIP RESTful 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 basic, oauth2, openIdConnect tokens manually.
Search Jentic for 'list global resources', load the operation schema, and execute with Jentic-managed credentials
28 endpoints — introduction welcome to the surevoip restful hypermedia api (sometimes known as a voip rest api, telecom rest api, sip api, hypermedia api or just voip api.
METHOD
PATH
DESCRIPTION
/
List global resources
/announcements
Add a new announcement audio file
/announcements
List global announcements
/areacodes
List areacodes
/billing
List global billing detail
/calls
Create phone calls with or without announcements and scheduled hangups
/calls
Validate a phone number by calling it once
/charges
Create charges for invoices
/
List global resources
/announcements
Add a new announcement audio file
/announcements
List global announcements
/areacodes
List areacodes
/billing
List global billing detail
/calls
Create phone calls with or without announcements and scheduled hangups
/calls
Validate a phone number by calling it once
/charges
Create charges for invoices
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the SureVoIP RESTful API by hand means supporting HTTP basic auth and its OAuth 2.0 and OpenID Connect flow, choosing between the production and sandbox hosts, and managing retries yourself. Through Jentic you install once, import the SureVoIP RESTful API from the API Directory, store the credentials once, and your agent calls it.
Permission scoping
The SureVoIP operations here work at the collection level, taking their targets in the request body rather than as URL path ids, so scope the agent to the operations it needs, such as listing calls or reading billing. Write operations like creating an announcement or a charge are only in reach if you include them in the allowed set.
Credential isolation
Your SureVoIP RESTful API credentials 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.
Intent-based discovery
Agents search Jentic by intent such as 'list global resources' or 'read the billing summary', and Jentic returns the matching SureVoIP RESTful API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Alternatives and complements available in the Jentic catalogue.
Specific to using The SureVoIP RESTful API through Jentic.
What authentication does the The SureVoIP RESTful API use?
The The SureVoIP RESTful API uses basic, oauth2, openIdConnect authentication. 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 list global resources with the The SureVoIP RESTful API?
Yes. Use the GET / endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the The SureVoIP RESTful 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 list global resources through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list global resources'. Jentic returns the matching The SureVoIP RESTful API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the The SureVoIP RESTful API have?
The The SureVoIP RESTful API exposes 28 endpoints covering announcements, areacodes, billing operations.
Can I limit what my agent is allowed to do with the SureVoIP RESTful API?
Yes. Because you run Jentic One yourself, your own rules decide which SureVoIP operations and credentials the agent can use, and these operations work at the collection level with their targets passed in the request body rather than as URL path ids. You can scope the agent to just the read operations it needs, such as listing calls or reading the billing detail, and leave everything else out of the allowed set. Write operations like creating an announcement or adding a charge are only reachable if you explicitly include them.
Know of an official OpenAPI document? Contribute it →
For Agents
Programmatically list global resources, add a new announcement audio file. Covers 28 operations with basic, oauth2, openIdConnect authentication.
Use for: I need to global resources, I want to add a new announcement audio file, Search for global announcements, Find all areacodes
Not supported: Does not handle payments, communications, or crm - use for productivity only.
Introduction Welcome to the SureVoIP RESTful hypermedia API (sometimes known as a VoIP REST API, Telecom REST API, SIP API, Hypermedia API or just VoIP API.) The SureVoIP API is a way for you to automate your interaction with the SureVoIP platforms. With the API, you can create your own scripts, applications or mashups which can: * List calls * create customers * search numbers * provision numbers. The API exposes 28 endpoints secured with basic, oauth2, openIdConnect authentication.
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.
Base layer of spec validity and structural soundness.
Aggregated quality score from linter diagnostics, weighted by severity.
Percentage of `$ref` references that resolve successfully.
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
Structural correctness score based on schema issues using logarithmic dampening.
Clarity, completeness, and ingestion readiness for developers and tooling.
How richly the API is illustrated with examples.
Percentage of examples that conform to their schemas.
Percentage of operations with complete response definitions (success, client error, server error).
Health of API ingestion, bundling, and resolution within Jentic pipelines.
Semantic breadth, depth, and agent comprehension for AI systems.
Coverage of descriptions across API elements.
Coverage of RFC 9457 Problem Details for error responses.
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
Coverage of summaries across operations/tags/info.
Functional utility, complexity comfort, and AI orchestration readiness.
Agent comfort level based on API operational and structural complexity.
Trust, risk posture, and security compliance.
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
Findability, semantic richness, and reasoning readiness.
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>