EPUB to Text API
Extracts an EPUB’s reading-order text and Dublin Core metadata, chapter by chapter.
- Endpoint
POST /v1/epub-to-text- Price
- $0.005 per call
- Family
- Documents
01When to use it
- Reading an EPUB means walking a zip, its container, its OPF spine and each XHTML chapter through a hardened fetch. An agent doing that inline walks past every SSRF control, and it is fiddly enough to be worth a paid endpoint.
- Your source is EPUB and you need plain text.
When not to use it
- The input is over 25 MB (26,214,400 bytes): epub-to-text answers too_large (413).
- The destination needs more than 45 s to answer: the call ends with upstream_timeout (424).
- The destination is on a private or local network: the network guard refuses it with blocked_target (403).
02Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| url | string | yes | Absolute http(s) URL of the .epub, up to 2048 characters; redirects are followed and the body must be a zip whose META-INF/container.xml points at an OPF package. |
| max_chapters | integer | no | How many leading XHTML/HTML spine chapters to extract, 1 to 5000; a shorter book is not an error, and a longer one is cut and reported as truncated. Default: 500. |
03Limits
| Limit | Value |
|---|---|
| Largest source file | 25 MB (26,214,400 bytes) |
| Timeout | 45 s |
| Source formats | EPUB |
| Output formats | plain text |
04Example
The published example of epub-to-text, verbatim: the request body and the response it returns.
POST /v1/epub-to-text
content-type: application/json
payment-signature: <base64 x402 payload>
{
"url": "https://grist.tools/samples/documents/seed-saving.epub",
"max_chapters": 500
}200 OK
payment-response: <base64 settlement receipt>
{
"source_url": "https://grist.tools/samples/documents/seed-saving.epub",
"metadata": {
"title": "A Short Guide to Seed Saving",
"creator": "Grist Samples",
"language": "en"
},
"chapter_count": 3,
"extracted_chapters": 3,
"truncated": false,
"chars": 441,
"chapters": [
{
"href": "OEBPS/ch1.xhtml",
"text": "Why Save Seeds\n\nSaving seeds keeps a variety that grows well in your own soil.\n\nIt also costs nothing and makes next spring easier to plan."
},
{
"href": "OEBPS/ch2.xhtml",
"text": "Choosing Plants\n\nPick the healthiest plants and let a few fruits ripen fully.\n\nBeans and peas are the easiest to start with.\n\nTomatoes need their seeds rinsed and dried."
},
{
"href": "OEBPS/ch3.xhtml",
"text": "Drying and Storing\n\nDry seeds on paper for a week, away from direct sun.\n\nStore them in labelled envelopes in a cool, dark place."
}
],
"text": "Why Save Seeds\n\nSaving seeds keeps a variety that grows well in your own soil.\n\nIt also costs nothing and makes next spring easier to plan.\n\nChoosing Plants\n\nPick the healthiest plants and let a few fruits ripen fully.\n\nBeans and peas are the easiest to start with.\n\nTomatoes need their seeds rinsed and dried.\n\nDrying and Storing\n\nDry seeds on paper for a week, away from direct sun.\n\nStore them in labelled envelopes in a cool, dark place."
}Sample file: documents/seed-saving.epub. Three-chapter EPUB 3 book about seed saving, with a nav document outside the spine and Dublin Core title, creator and language, hand-written with pinned zip dates.
The returned text runs to 19 lines, 9 blank ones among them, and its longest line, "Saving seeds keeps a variety that grows well in your own soil.", holds 62 characters. Its first line reads "Why Save Seeds" and its last "Store them in labelled envelopes in a cool, dark place." Split on whitespace, it yields 79 tokens over 10 non-blank lines.
| Response field | Type | In the example |
|---|---|---|
| source_url | string | "https://grist.tools/samples/documents/seed-saving.epub" |
| metadata | object | an object with title, creator and language |
| chapter_count | number | 3 |
| extracted_chapters | number | 3 |
| truncated | boolean | false |
| chars | number | 441 |
| chapters | array | 3 items, each with href and text |
| text | string | a string of 441 characters |
05Call it from code
// epub-to-text: $0.005 per call, paid in USD Coin on eip155:8453 via x402
// Install: npm install @x402/fetch@2 @x402/evm@2 viem@2
// Save as client.mjs (ES module, Node 18+), export EVM_PRIVATE_KEY with the paying wallet's key in your shell, then run: node client.mjs
// The wrapper reads the 402 (payment-required), signs and retries with payment-signature.
import { wrapFetchWithPayment, x402Client, decodePaymentResponseHeader } from '@x402/fetch'
import { ExactEvmScheme } from '@x402/evm/exact/client'
import { privateKeyToAccount } from 'viem/accounts'
const account = privateKeyToAccount(process.env.EVM_PRIVATE_KEY)
const client = new x402Client().register('eip155:8453', new ExactEvmScheme(account))
const fetchWithPayment = wrapFetchWithPayment(fetch, client)
const body = {
"url": "https://grist.tools/samples/documents/seed-saving.epub",
"max_chapters": 500
}
const res = await fetchWithPayment('https://grist.tools/v1/epub-to-text', {
method: 'POST',
headers: { 'content-type': 'application/json' },
body: JSON.stringify(body),
})
console.log(res.status, await res.json())
const settle = res.headers.get('payment-response')
if (settle) console.log(decodePaymentResponseHeader(settle).transaction)# epub-to-text: $0.005 per call, paid in USD Coin on eip155:8453 via x402
# Install: pip install "x402[requests,evm]>=2.24,<3"
# The session reads the 402 (payment-required), signs and retries with payment-signature.
import os
from eth_account import Account
from x402 import x402ClientSync
from x402.http import decode_payment_response_header
from x402.http.clients.requests import x402_requests
from x402.mechanisms.evm.exact import register_exact_evm_client
from x402.mechanisms.evm.signers import EthAccountSigner
account = Account.from_key(os.environ["EVM_PRIVATE_KEY"])
client = x402ClientSync()
register_exact_evm_client(client, EthAccountSigner(account), networks="eip155:8453")
session = x402_requests(client)
payload = {
"url": "https://grist.tools/samples/documents/seed-saving.epub",
"max_chapters": 500
}
res = session.post("https://grist.tools/v1/epub-to-text", json=payload)
print(res.status_code, res.json())
settle = res.headers.get("payment-response")
if settle:
print(decode_payment_response_header(settle).transaction)# epub-to-text: $0.005 per call, paid in USD Coin on eip155:8453 via x402
# 1. Unpaid call: HTTP 402, the requirements in the payment-required header (base64 JSON) and in the body.
curl -i -X POST 'https://grist.tools/v1/epub-to-text' -H 'content-type: application/json' -d '{"url":"https://grist.tools/samples/documents/seed-saving.epub","max_chapters":500}'
# 2. Same call with the signed payment (an EIP-3009 authorization, EIP-712 signed: it cannot be
# typed by hand). x-payment is accepted as the v1 alternative. HTTP 200 carries payment-response.
curl -i -X POST 'https://grist.tools/v1/epub-to-text' -H 'content-type: application/json' -H 'payment-signature: <base64 x402 payload>' -d '{"url":"https://grist.tools/samples/documents/seed-saving.epub","max_chapters":500}'06Errors
| Code | HTTP | For this service |
|---|---|---|
| invalid_input | 400 | The body does not match the schema; its fields are url and max_chapters. |
| blocked_target | 403 | |
| unreachable_target | 424 | |
| upstream_timeout | 424 | |
| unsupported_content_type | 415 | The source is not a type epub-to-text reads; it reads EPUB. |
| too_large | 413 | |
| unprocessable | 422 | |
| internal | 500 |
Input that is rejected before the tool runs (malformed JSON, schema mismatch, body over the size limit) is never charged.
When each code is raised, and what it means for payment: /docs/epub-to-text.
07Conversions
| Conversion | Recorded sample | Source size | Output size |
|---|---|---|---|
| EPUB to plain text | documents/seed-saving.epub | 2.4 KB | 441 bytes |
08Questions
- How much does a epub-to-text call cost?
- $0.005 per call, paid in USDC on Base via x402, with no account and no API key.
- What does epub-to-text return?
- A JSON object with 8 top-level fields: source_url, metadata, chapter_count, extracted_chapters, truncated, chars, chapters and text. The example on this page is a real call over documents/seed-saving.epub.
- What happens when a epub-to-text call fails?
- The tool answers with a typed JSON error from the errors table. Payment is settled only after the tool has produced its result; a call that fails inside the tool is never settled. A 503 upstream_unavailable can follow a settled call; the x402 payments guide covers it, 429, 402 and an uncertain 500.