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

# Epublys API

The Epublys API manipulates EPUB and PDF ebooks: it merges several files into one, splits an EPUB into chapters, compresses files, and validates them. It converts between EPUB, PDF, DOCX, and Markdown, and reads or edits EPUB metadata such as the title and author. All file data is passed as base64-encoded JSON, and a usage endpoint reports the remaining allowance on the account.

## For AI agents

Merge, split, compress, and validate EPUB files, convert between EPUB, PDF, DOCX, and Markdown, and read or edit ebook metadata. Authenticated with a bearer API key.

## Scope

Does not handle ebook storage, DRM, or online reading. Use for EPUB and PDF conversion, merging, and validation only.

## Capabilities

- Merge multiple EPUB files into a single ebook
- Split an EPUB into individual chapters or pull a chapter range out as one EPUB
- Convert between EPUB, PDF, DOCX, and Markdown formats
- Read and edit EPUB metadata such as the title and author
- Validate an EPUB and compress it to reduce file size
- Generate an AI book cover on the Pro plan and read the remaining account allowance

## Use cases

### Ebook Format Conversion

A publishing workflow needs a manuscript available in several formats. The Epublys API converts a Word document or Markdown source into EPUB, turns an EPUB into PDF for print proofs, and converts an EPUB back to Markdown for editing, sending the file content as base64 JSON in each direction.

Example prompt: Convert a DOCX manuscript to EPUB, then convert that EPUB to PDF, passing the file as base64-encoded JSON each time

### EPUB Validation and Metadata Cleanup

Before distributing an ebook, a team validates the EPUB, edits its metadata so the title and author are correct, and compresses the file to keep the download small. The Epublys API returns validation results an agent can branch on and merges metadata edits without rebuilding the book.

Example prompt: Validate an EPUB, edit its metadata to set the title and author, then compress the file

### AI Agent Ebook Pipeline via Jentic

An AI agent assembles and ships an ebook through Jentic without holding the Epublys API key itself. It searches by intent, receives the matching operation and its input schema, and runs conversion, validation, and metadata edits with the credential injected at run time, so a build-and-publish sequence runs on its own.

Example prompt: Search Jentic for 'convert a document to EPUB', load the conversion operation schema, and run it with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/merge` | Merge multiple EPUBs into one |
| POST | `/split` | Split an EPUB into chapters or a chapter range |
| POST | `/epub-to-pdf` | Convert an EPUB to PDF |
| POST | `/pdf-to-epub` | Convert a PDF to EPUB |
| POST | `/metadata` | Read EPUB metadata |
| POST | `/validate` | Validate an EPUB |
| GET | `/usage` | Read the account's remaining allowance |

## Key resources

- **Conversion** — Convert between EPUB, PDF, DOCX, and Markdown via /epub-to-pdf, /pdf-to-epub, /docx-to-epub, /markdown-to-epub, and /epub-to-markdown
- **Editing** — Merge, split, compress, and validate files via /merge, /split, /compress, and /validate
- **Metadata and Account** — Read and edit EPUB metadata via /metadata and `/metadata/edit`, and read the account allowance via /usage

## 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:** 67 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 90 / 100
  - Developer Experience & Jentic Compatibility: 69 / 100
  - AI-Readiness & Agent Experience: 48 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 75 / 100
- **View full report:** https://jentic.com/apis/epublys.com/epublys/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 Epublys by hand means managing its bearer key, base64-encoding every file into JSON, and decoding the result on each conversion. Through Jentic you install once, import Epublys from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Epublys carries the file inside the request body, so rules bound which operations your agent may call, not which file. Limit the agent to the operations it needs, such as merge, convert, and validate, so cover generation and the Pro upgrade operation are not included unless you add them.
- **Credential handling:** Your Epublys 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 'convert an EPUB to PDF' or 'validate an ebook', and Jentic returns the matching Epublys operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **CloudConvert API** — General file-conversion service spanning many document, image, and ebook formats
- **ExactPDF API** — Inspect PDFs, extract text, and convert PDFs to structured Markdown or JSON
- **PDF.co API** — Broad PDF toolkit for parsing, editing, and generating PDF documents

## FAQ

### What authentication does the Epublys API use?

The Epublys API authenticates with a bearer API key in the Authorization header per its OpenAPI spec. A free key is available from the Epublys account page, with a Pro tier for higher limits. Through Jentic the key is stored encrypted by your own Jentic One instance and injected at execution time, so it never reaches the agent.

### Can I convert between EPUB, PDF, DOCX, and Markdown with the Epublys API?

Yes. The Epublys API has dedicated conversion operations for EPUB to PDF, PDF to EPUB, DOCX to EPUB, Markdown to EPUB, and EPUB to Markdown. Each sends and receives the file as base64-encoded JSON, so an agent can chain conversions without handling binary uploads directly.

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

The OpenAPI spec does not state specific numeric rate limits for the Epublys API. A free tier and a paid Pro tier with higher limits are offered per the API's own description, and the usage operation reports the remaining allowance on your account so an agent can pace itself.

### How do I convert a document to EPUB with the Epublys API through Jentic?

Search Jentic for 'convert a document to EPUB' and it returns the matching Epublys conversion operation with its input schema. Load the schema, send the file as base64 JSON, and the credential is injected at run time. To run it on your own infrastructure, install Jentic One from its GitHub repo.

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

Yes. Epublys carries the file in the request body, so a rule bounds which operations your agent may call rather than which file. Limit it to the operations it needs, such as conversion and validation, and leave cover generation or the Pro upgrade operation out unless you add them.

### Is there an Epublys API MCP server?

You don't need an MCP server to give your agent the Epublys API. Jentic connects it directly from the API Directory: import it, store your key once, and your agent calls the conversion and validation operations it needs without a separate server to install.
