canonical: https://jentic.com/apis/heyjodie.com/heyjodie

# Heyjodie Jodie API

The Jodie API exposes account and call-history operations for Jodie, an AI-powered calling assistant that handles inbound and outbound voice conversations. Two endpoints let an integration read user account information and list calls handled by Jodie's voice agent, with webhook support documented separately for real-time event streams. Authentication uses a Bearer token issued from the Jodie dashboard.

## For AI agents

Read Jodie account information and list AI-handled call records via Bearer-token authentication for the Jodie voice-agent platform.

## Scope

Does not handle SMS, video conferencing, or phone-number provisioning - use for reading Jodie account information and AI-handled call records only.

## Capabilities

- Read the authenticated user's Jodie account information via GET `/api/user`
- List call records handled by Jodie's AI voice assistant through GET `/api/calls`
- Build a CRM-style call-history view by paginating GET `/api/calls` and joining with internal contact records
- Surface AI-handled call counts and outcomes in a workspace dashboard
- Trigger downstream automations (CRM updates, follow-up tasks) when new call records appear

## Use cases

### AI Call History Dashboard

Operations teams call GET `/api/calls` on a schedule to populate an internal dashboard of calls Jodie has handled, including timestamps and any structured outcomes Jodie surfaces. This gives leaders visibility into AI call coverage without logging into the Jodie console for each shift.

Example prompt: Call GET `/api/calls` with a time-range filter, group results by hour, and post the totals to an internal dashboard.

### CRM Sync for AI-Handled Calls

Sales platforms poll GET `/api/calls` and write each new record into a CRM contact's activity timeline so reps know when Jodie has spoken to a lead. This ensures AI-handled calls are visible alongside human calls in the same pipeline view rather than living in a separate silo.

Example prompt: Poll GET `/api/calls` every 5 minutes, then for each new call id, post the call summary to the matching CRM contact's activity feed.

### Account Health Check

Account managers verify that their Jodie account is provisioned correctly by calling GET `/api/user` during onboarding or post-incident. The response confirms the user identity and any account-level metadata, which helps an agent diagnose whether a missing call is an auth issue or a routing problem.

Example prompt: Call GET `/api/user` and assert that the returned account status is active before triggering downstream calls.

### AI Agent Call Coordination

Through Jentic, an AI agent can call 'list my recent voice agent calls' and turn the result into a daily standup summary, or check user-account state before delegating work to Jodie. Jentic's vault holds the Bearer token so the agent never sees the credential while still pulling Jodie's call data.

Example prompt: Search Jentic for 'list ai-handled calls', execute GET `/api/calls` for the last 24 hours, and produce a one-paragraph summary of call volume.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/user` | Get account information for the authenticated user |
| GET | `/api/calls` | List calls handled by Jodie's AI voice agent |

## Key resources

- **User** — Read the authenticated user's account information
- **Calls** — List calls handled by Jodie's AI voice agent

## Why Jentic

- **Setup:** Wiring the Jodie API by hand means learning its bearer token auth and adding the Authorization header on every call to its account and call-record endpoints. Through Jentic you install once, import the Jodie API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** The Jodie API exposes read-only account and call-record endpoints (`/api/user`, `/api/calls`) with no resource id in the path, so limit the agent to the operations it needs, such as reading account information or listing AI-handled calls. There is nothing to write or delete, so the allowed set is exactly the reads it needs.
- **Credential handling:** Your Jodie bearer token is stored once, encrypted, by your own Jentic One instance and injected as the Authorization header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list AI-handled calls' or 'read account information', and Jentic returns the matching Jodie operation with its input schema so the agent calls the right endpoint without scanning the spec.

## Related APIs

- **Retell AI API** — Retell AI provides programmable AI voice agents with similar inbound and outbound calling capabilities
- **Bland AI API** — Bland AI offers AI phone agents with extensive call orchestration controls
- **Twilio Voice API** — Twilio Voice provides the underlying carrier and SIP infrastructure for any AI voice agent stack

## FAQ

### What authentication does the Jodie API use?

Jodie uses Bearer token authentication. Generate the token from the Jodie dashboard and pass it in the Authorization: Bearer <token> header. Through Jentic, the token is stored in the encrypted vault and injected at execution time.

### Can I list calls Jodie handled with the API?

Yes. GET `/api/calls` returns the call records that Jodie's AI voice agent processed for the authenticated account. Pair it with a polling loop or Jodie's webhooks (documented in the Jodie developer docs) to surface new calls in near real time.

### How do I retrieve Jodie account information through Jentic?

Run pip install jentic, search for 'get my account information', and execute against GET `/api/user.` Jentic resolves the Bearer token from the vault and returns the JSON response.

### Does the Jodie API support webhooks?

Yes - webhooks are documented in the Jodie developer docs even though the spec only enumerates two REST endpoints. Configure the webhook URL in the Jodie dashboard to receive call events instead of polling `/api/calls.`

### What rate limits apply to the Jodie API?

The current spec does not publish explicit rate limits. Implement standard backoff on HTTP 429 responses and prefer webhook-driven event flows over high-frequency polling of `/api/calls.`

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

Yes. Because you run Jentic One yourself, your own rules decide which Jodie operations the agent may call and which credentials it may use. The Jodie API is read-only, exposing just GET `/api/user` for account information and GET `/api/calls` for AI-handled call records, so you can scope the agent to only one of these, for example allowing it to list calls but not read account details. There is nothing to write or delete, so the allowed set is exactly the reads you grant.