For Agents
Programmatically post custom event, send message. Covers 9 operations with apiKey authentication.
Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Regal 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%2Fregal.io%2Fregal" | 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%2Fregal.io%2Fregal" | 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 Regal API.
Post custom event
Send message
List business profiles
Create branded phone number
GET STARTED
Use for: I need to post custom event, I want to send message, Search for business profiles, Find all campaigns
Not supported: Does not handle payments, crm, or developer tools - use for communications only.
Regal is an event-driven outbound contact center platform. The API enables sending events, messages, managing campaigns, dispositions, business profiles, and branded phone numbers. The API exposes 9 endpoints secured with apiKey authentication.
Monitor Regal API operational status and events
Patterns agents use Regal API for, with concrete tasks.
★ Communications Operations
Use the Regal API to perform communications operations programmatically. The API provides 9 endpoints covering core functionality including post custom event, send message, list business profiles.
Call POST /events to post custom event
Automated Events Management
Automate events operations by combining multiple Regal API endpoints. Agents can send message and then list business profiles in a single workflow.
Call POST /messages/send to send message, then verify the result
AI Agent Integration via Jentic
AI agents discover and call Regal 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.
Search Jentic for 'post custom event', load the operation schema, and execute with Jentic-managed credentials
9 endpoints — regal is an event-driven outbound contact center platform.
METHOD
PATH
DESCRIPTION
/events
Post custom event
/messages/send
Send message
/businessProfiles
List business profiles
/campaigns
List campaigns
/dispositions
List dispositions
/brandedPhoneNumbers
Create branded phone number
/brandedPhoneNumbers
List branded phone numbers
/brandedPhoneNumbers/{phoneNumber}
Update branded phone number
/events
Post custom event
/messages/send
Send message
/businessProfiles
List business profiles
/campaigns
List campaigns
/dispositions
List dispositions
/brandedPhoneNumbers
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Regal API by hand means setting your key in the Authorization header, choosing between the events.regalvoice.com and api.regal.ai hosts, and building your own retry handling. Through Jentic you install once, import the Regal API from the API Directory, store the key once, and your agent calls it.
Permission scoping
The Regal API puts the phone number in the URL path (/brandedPhoneNumbers/{phoneNumber}) alongside body-based endpoints like /events and /messages/send, so a rule can pin your agent to reading and updating a given branded phone number. You choose the operations it may call, so send operations like posting an event or sending a message are not included unless you add them.
Credential isolation
Your Regal 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.
Intent-based discovery
Agents search Jentic by intent such as 'post a custom event' or 'list branded phone numbers', and Jentic returns the matching Regal 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 Regal API through Jentic.
What authentication does the Regal API use?
The Regal API uses an API key passed in the `Authorization` 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 post custom event with the Regal API?
Yes. Use the POST /events endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the Regal 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 post custom event through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'post custom event'. Jentic returns the matching Regal API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the Regal API have?
The Regal API exposes 9 endpoints covering events, messages, business profiles operations.
Can I limit what my agent is allowed to do with the Regal API?
Yes. Because Jentic One is self-hosted, you set the rules that decide which Regal API operations and credentials your agent may use. You can pin the agent to read-only work such as listing business profiles, campaigns, and branded phone numbers, or scope it to reading and updating a single branded phone number since that number sits in the URL path at /brandedPhoneNumbers/{phoneNumber}. Send operations like posting an event via /events or sending a message via /messages/send are not included unless you add them, and the encrypted API key is injected only for the calls you permit.
Create branded phone number
/brandedPhoneNumbers
List branded phone numbers
/brandedPhoneNumbers/{phoneNumber}
Update branded phone number