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

# Edwyna API

The Edwyna API sends paid outbound faxes to United States and Canada destinations, powered by FaxZero. An agent uploads one PDF of up to 25 pages, creates a draft that synchronously validates the document and returns an exact server-generated quote, then sends the fax to a single recipient by charging the prepaid balance. It also reports authoritative pricing, the available balance, each fax's delivery state, and downloadable transmitted-document and delivery-record PDFs.

## For AI agents

Send a one-recipient PDF fax to US and Canada numbers: upload the PDF, get an exact quote, charge the prepaid balance to send, and track delivery state and records.

## Scope

Does not send email, SMS, or voice calls, and does not reach destinations outside the US and Canada. Use for outbound PDF fax only.

## Capabilities

- Upload a PDF and get an exact server-generated fax quote before sending
- Send a one-recipient fax to US and Canada destinations by charging the prepaid balance
- Check the available prepaid balance and authoritative per-fax pricing
- List faxes and read each fax's current delivery state
- Download the transmitted document and the delivery-record PDF after delivery

## Use cases

### Agent-sent document fax

An agent that needs to fax a signed document uploads the PDF to Edwyna, creates a draft to validate it and receive an exact quote, then sends it to the recipient by charging the prepaid balance. The upload, draft, and send operations are discovered through Jentic by intent, so the agent runs the sequence without wiring the handoff steps by hand.

Example prompt: Upload a PDF, create a fax draft to get the quote, then send the fax to one recipient and confirm it was queued

### Pre-send quoting and balance checks

Before committing to a send, an agent reads Edwyna's authoritative pricing and the available prepaid balance to confirm there is enough credit to cover the quote. Creating a draft is non-consequential and does not deduct credit, so the agent can validate and price a fax without sending it.

Example prompt: Fetch the fax price and the current prepaid balance, then create a draft to confirm the exact quote without sending

### Delivery tracking and record retrieval

After a fax is sent, an agent polls its delivery state and, once delivered, downloads the transmitted document and Edwyna's delivery-record PDF for an audit trail. This lets a workflow confirm receipt and archive proof of transmission for each fax.

Example prompt: Check a fax's delivery state, and once it is delivered, download its delivery-record PDF

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/v1/fax-drafts` | Upload, validate, and quote one PDF fax |
| POST | `/v1/fax-drafts/{fax_id}/send` | Charge the prepaid balance and queue one fax |
| GET | `/v1/faxes` | List faxes for the authenticated customer |
| GET | `/v1/faxes/{fax_id}` | Get one fax and its delivery state |
| GET | `/v1/pricing` | Get an authoritative fax price |
| GET | `/v1/balance` | Get the available prepaid balance |
| POST | `/v1/pdf-uploads` | Create a single-use PDF upload URL |
| GET | `/v1/faxes/{fax_id}/delivery-record` | Download the delivery-record PDF |

## Key resources

- **Pricing** — Get an authoritative, server-generated fax price
- **Balance** — Read the available prepaid balance
- **Faxes** — Create drafts, send faxes, list faxes, and read delivery state and records
- **PDF handoff** — Create short-lived, single-use PDF upload URLs and check readiness

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 66 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 87 / 100
  - Developer Experience & Jentic Compatibility: 64 / 100
  - AI-Readiness & Agent Experience: 47 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 83 / 100
- **View full report:** https://jentic.com/apis/edwyna.com/edwyna/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Edwyna API by hand means handling its bearer API secret, keeping enough prepaid balance to cover each quote, and sequencing the PDF upload, draft, and send steps yourself. Through Jentic you install once, import the Edwyna API from the API Directory, store the secret once, and your agent calls it.
- **Permission scoping:** Edwyna puts the fax id in the URL path (`/v1/faxes/{fax_id}`), so a rule can limit your agent to reading and tracking faxes. You choose the operations it may call, so the balance-charging send operation is not included unless you add it.
- **Credential handling:** Your Edwyna secret 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 'quote a fax' or 'send a PDF fax', and Jentic returns the matching Edwyna operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Telnyx** — Programmable fax, voice, and messaging over a telephony network
- **Plivo** — Voice and SMS messaging APIs

## FAQ

### What authentication does the Edwyna API use?

The Edwyna API authenticates with a bearer API secret per its OpenAPI spec, and each key carries explicit scopes and spending limits. Through Jentic the secret is stored encrypted by your own Jentic One instance and injected at execution time, so it never enters the agent's context or a user-visible prompt.

### Can I send a fax to a US number with the Edwyna API?

Yes. Edwyna sends one PDF of up to 25 pages to a single recipient at US and Canada destinations. You upload the PDF, create a draft to validate it and get an exact quote, then call the send operation to charge your prepaid balance and queue the fax.

### What are the rate limits for the Edwyna API?

The OpenAPI spec does not state request rate limits; sending is gated by your available prepaid balance, which must cover the quote. Check the Edwyna documentation at https://edwyna.com for current limits and pricing.

### Is there an Edwyna MCP server?

You don't need an MCP server to give your agent the Edwyna API. Jentic connects it directly from the API Directory: import it, store your secret once, and your agent calls the quote, send, and tracking operations it needs.

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

Yes. Write a rule that allows only the read operations, such as pricing, balance, and fax status, so the agent can quote and track faxes but cannot spend your balance. The balance-charging send operation is left out unless you add it, and every call the agent makes is logged.

### How do I send a fax through Jentic?

Search Jentic for 'send a PDF fax', and it returns the Edwyna draft and send operations with their input schemas; your agent uploads the PDF, confirms the quote, and sends. To run it on your own infrastructure, install Jentic One from its GitHub repo.