Aria Omni

Aria Omni API

Put Aria inside your own apps, and its outcomes in your systems.

Use the API to give your app, customer portal or kiosk the same agent that answers your phones. After every conversation, signed webhooks send the summary and outcome to the systems your team already uses.

Request a pilot
  • Keys you control
  • Signed webhooks
  • Same agent as your phones
  • Included in every plan
POST /api/v1/channel-api/v1/invoke
Authorization: Bearer aria_ch_…
{ "message": "Do you deliver on Saturdays?" }

201 { "sessionId": "…",
  "reply": "Yes, between 9 a.m. and 1 p.m.",
  "escalationTriggered": false }

What it does

One call to converse

Send a customer’s message and get Aria’s reply. Keep the session ID to continue the same conversation.

Keys you control

Create a key for each app or channel, and revoke one at once without touching the others.

Signed webhooks

After every conversation, Aria Omni posts the outcome and summary to your endpoint, signed so you can prove it came from us.

Escalation built in

Each reply says whether the customer asked for a person, so your app can hand over to your team.

Outcomes where your team works

Summaries and outcomes can go to your CRM or helpdesk through the integrations you connect.

Same knowledge, same limits

API conversations use the agent’s released knowledge and rules, and never take card numbers or passwords.

How it fits together

1. Create a key

In the workspace, create an API key for the agent version you want behind your app.

2. Send messages

Call the invoke endpoint with the customer’s message and, for follow-ups, the session ID.

3. Receive outcomes

Register a webhook endpoint and receive each conversation’s outcome, signed.

Questions

Common questions.

Something else? , or write to mercury@pivotal-b2b.com.

How do we authenticate API requests?

With a channel API key sent as a Bearer token. Keys are created and revoked in the workspace, one for each app or channel.

How do we continue a conversation?

Each reply includes a session ID. Send it with the next message and Aria continues the same conversation.

How do we know a webhook came from Aria Omni?

Every webhook carries a signature header computed with a secret you hold, with a timestamp, so you can check it and reject replays.

Is the API priced separately?

No. API and website chat conversations are included in the Production plan, which is priced on phone minutes.

Start with one line

Answer your next conversation with Aria.

A free 30-day pilot on one of your own lines. Tell us which line and roughly how many calls it takes, and we’ll reply with a pilot plan.

Request a pilot

We reply within one business day. See pricing.