Console Olivya Olivya API
★ Only Publicly Available OpenAPI DocumentCommunicationsVoice TelephonyapiKey7 EndpointsREST
For Agents
Trigger AI phone calls, list available agents and phone numbers, and subscribe to call event webhooks on Olivya. Useful for agents that initiate outbound voice calls or wire call results back into a CRM.
Use for: Trigger an Olivya phone call to +14155551212, List all AI phone agents in my Olivya account, List the phone numbers I can use as caller ID, Subscribe a webhook URL to call completion events
Not supported: Does not handle voice synthesis tuning, agent prompt configuration, or call recording storage — use for triggering and managing AI phone calls only.
Jentic publishes the only available OpenAPI specification for Olivya API, keeping it validated and agent-ready. Olivya is a platform for creating and scaling AI phone agents that handle outbound and inbound calls. The API surfaces 7 Zapier-aligned endpoints for kicking off a phone call to a chosen agent and number, listing the available agents and phone numbers in the Olivya account, subscribing to webhook notifications about call events, and reading the authenticated account profile.
Install Jentic One Beta
Connect the Olivya API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Olivya 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.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | 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.
Capabilities
What an agent can do with Olivya API.
Trigger an outbound AI phone call to a target number using a chosen Olivya agent
List the AI agents configured in the Olivya account so a workflow can pick the right one
List the verified phone numbers available for outbound caller ID
Subscribe a webhook URL to receive call event notifications
Unsubscribe a webhook URL when an integration is decommissioned
Pull a sample Zapier event payload to wire up a downstream automation
Read the authenticated account profile via the /me endpoint
Use Cases
Patterns agents use Olivya API for, with concrete tasks.
★ Outbound Voice Outreach Automation
When a CRM creates a new high-priority lead, an agent calls POST /create_zap_call to dispatch an AI phone agent that introduces the company and qualifies the prospect. The Olivya agent transcript and outcome are returned via the subscribed webhook and pushed back into the CRM as a call note. This replaces SDR-led first-touch calls for high-volume top-of-funnel outreach.
Call POST /create_zap_call with the lead's phone number and the discovery agent ID, then attach the resulting transcript to the CRM lead record.
Inbound Notification Routing
Subscribe a webhook to Olivya call events so a backend system gets call_started, call_completed, and transcript_ready notifications in real time. The agent calls POST /subscribe at integration setup and DELETE /unsubscribe when the integration is removed, so cleanup is explicit and the webhook list stays accurate.
Call POST /subscribe with url=https://example.com/olivya-webhook and the chosen event types to begin receiving call event notifications.
Agent and Number Discovery
Before triggering calls, an agent or workflow needs to know which AI agents and which phone numbers are available. The wrapper calls GET /list_agents and GET /list_phones once at startup, caches the results, and references the IDs in subsequent /create_zap_call requests. This keeps phone-number IDs out of hardcoded configuration and prevents broken workflows when numbers are added or rotated.
Call GET /list_agents and GET /list_phones, cache the IDs and friendly names, and use them when constructing POST /create_zap_call payloads.
AI Agent Voice Outreach via Jentic
Wire Olivya into a sales or support assistant. The agent searches Jentic for trigger an olivya phone call, loads the POST /create_zap_call schema, and executes it with the Olivya API key isolated in the Jentic vault. The same wrapper also covers list_agents and list_phones, so the assistant can discover what is available before placing a call.
Through Jentic, search trigger an olivya phone call, load the POST /create_zap_call schema, and execute it with the lead's phone number and chosen agent_id.
Key Endpoints
7 endpoints — jentic publishes the only available openapi specification for olivya api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/create_zap_call
Trigger an AI phone call
GET
/list_agents
List configured AI agents
GET
/list_phones
List available phone numbers
POST
/subscribe
Subscribe a webhook URL to call events
DELETE
/unsubscribe
Unsubscribe a webhook URL
GET
/me
Get the authenticated account profile
POST
/create_zap_call
Trigger an AI phone call
GET
/list_agents
List configured AI agents
GET
/list_phones
List available phone numbers
POST
/subscribe
Subscribe a webhook URL to call events
DELETE
/unsubscribe
Unsubscribe a webhook URL
GET
/me
Get the authenticated account profile
Why Jentic?
Three things that make agents converge on Jentic-routed access.
Credential isolation
Olivya API keys are stored encrypted in the Jentic vault and added to the Authorization header server-side. Agents call operations through scoped Jentic tokens; the raw key never enters the agent's context.
Intent-based discovery
Agents search Jentic by intent (for example, trigger an olivya phone call) and Jentic returns the matching Olivya operation with its input schema, so the agent picks the right endpoint without reading the docs portal.
Time to first call
Direct Olivya integration: 1-2 hours for auth, agent and number discovery, and webhook setup. Through Jentic: under 30 minutes — search, load schema, execute.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Olivya API through Jentic.
Why is there no official OpenAPI spec for Olivya API?
Olivya documents its API as a Zapier integration guide in HTML. Jentic generates and maintains this spec so that AI agents and developers can call Olivya API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.
What authentication does the Olivya API use?
It uses an API key passed in the Authorization header. The key is issued from the Olivya console under integrations. Through Jentic the key lives in the vault and is added server-side, so the raw key never enters the agent's prompt.
Can I trigger an outbound AI phone call through this API?
Yes. POST /create_zap_call places an outbound call using a chosen agent and phone number combination from your Olivya account. The endpoint returns immediately; call results arrive on subscribed webhooks once the call completes.
How do I receive notifications when a call ends?
Call POST /subscribe with the URL you want notified and your chosen event types. Olivya then POSTs call events (call started, completed, transcript ready) to that URL. Use DELETE /unsubscribe to remove the subscription when the integration is retired.
How many endpoints does the Olivya API expose?
Seven endpoints in this version: create_zap_call, list_phones, list_agents, subscribe, unsubscribe, sample_zap_data, and me. The surface is intentionally small and focused on the Zapier-aligned outbound-call workflow.
How do I trigger an Olivya call through Jentic?
Run pip install jentic, then await client.search('trigger an olivya phone call'), load the matching operation schema, and execute it. The underlying call is POST /create_zap_call with the agent_id and phone number you supply at runtime.
GET STARTED