canonical: https://jentic.com/apis/regal.ai/regal

# Regal API

Regal API for customer engagement - events, messaging, campaigns, dispositions, and phone number management. The API exposes 6 endpoints secured with apiKey authentication.

## For AI agents

Programmatically post a custom event, send an sms message. Covers 6 operations with apiKey authentication.

## Scope

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

## Capabilities

- Post a custom event
- Send an SMS message
- List active phone numbers
- Query and filter Regal API records by parameters
- Monitor Regal API operational status and events

## Use cases

### Marketing Operations

Use the Regal API to perform marketing operations programmatically. The API provides 6 endpoints covering core functionality including post a custom event, send an sms message, list active phone numbers.

Example prompt: Call POST /events to post a custom event

### Automated Business Profiles Management

Automate business profiles operations by combining multiple Regal API endpoints. Agents can send an sms message and then list active phone numbers in a single workflow.

Example prompt: Call POST /messages/send to send an sms 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.

Example prompt: Search Jentic for 'post a custom event', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /events | Post a custom event |
| POST | /messages/send | Send an SMS message |
| GET | /activePhoneNumbers | List active phone numbers |
| GET | /campaigns | List all campaigns |
| GET | /dispositions | List call dispositions |
| GET | /businessProfiles | List business profiles |

## Key resources

- **Business Profiles** — Operations related to Business Profiles
- **Campaigns** — Operations related to Campaigns
- **Dispositions** — Operations related to Dispositions
- **Events** — Operations related to Events
- **Messages** — Operations related to Messages

## Why Jentic

- **Setup:** Wiring the Regal API by hand means setting your key in the Authorization header on every call and building your own retry handling against the api.regal.ai host. 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 uses collection endpoints like /events, /messages/send, and /campaigns with the target in the request body, so scoping is by operation: limit the agent to the operations it needs, such as reading campaigns or active phone numbers, rather than to a single record. Send operations like posting an event or sending a message are only available if you include them.
- **Credential handling:** 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.
- **Discovery method:** Agents search Jentic by intent such as 'post a custom event' or 'send a message', and Jentic returns the matching Regal API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mailchimp** — Alternative marketing API
- **Hubspot** — Alternative marketing API

## FAQ

### 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 a 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 a 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 a 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 6 endpoints covering business profiles, campaigns, dispositions operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Regal API operations and credentials the agent may use, and scoping is by operation. You can allow the agent only the read calls it needs, such as listing campaigns, active phone numbers, dispositions, or business profiles, while withholding the send operations like posting a custom event or sending an SMS message. Only the operations you include are available to the agent.