EPUB to Text API

Extracts an EPUB’s reading-order text and Dublin Core metadata, chapter by chapter.

Updated

Agents read this page asGET /v1/epub-to-text/schemafree: schema, examples, errors, price

Endpoint
POST /v1/epub-to-text
Price
$0.005 per call
Timeout
45 s
max_timeout_seconds
66 (the whole call as the 402 envelope sells it: the timeout, plus payment verification and settlement around it)
Response cap
25 MB (26,214,400 bytes)
Family
Documents

When 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).

Parameters

One JSON body. The schema is free at GET /v1/epub-to-text/schema.

FieldTypeRequiredDescription
urlstringyesAbsolute 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_chaptersintegernoHow 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.

Limits

LimitValue
Largest source file25 MB (26,214,400 bytes)
Timeout45 s
Source formatsEPUB
Output formatsplain text
Show the JSON Schema the handler validates against
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 2048,
      "format": "uri",
      "description": "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": {
      "default": 500,
      "description": "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.",
      "type": "integer",
      "minimum": 1,
      "maximum": 5000
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}

Example

The published example, verbatim: the request and the response it returns.

Request
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
}

Without the payment-signature header the call answers 402 with the payment requirements, including this endpoint's price and its max_timeout_seconds, so the deadline is known before anything is paid. The payment is verified before the handler runs and settled only after it succeeds, so a call refused by the gate, or one that fails inside the handler, is never settled. The single case we cannot state for you is a settlement call that fails without answering: the error message says so when that is what happened.

Response200 OK
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 fields

FieldTypeIn the example
source_urlstring"https://grist.tools/samples/documents/seed-saving.epub"
metadataobjectan object with title, creator and language
chapter_countnumber3
extracted_chaptersnumber3
truncatedbooleanfalse
charsnumber441
chaptersarray3 items, each with href and text
textstringa string of 441 characters

Deterministic: the same input returns the same output. Clock-derived fields, when present, are declared in the response.

Call it from code

The client reads the 402, signs the payment and retries on its own.

// 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)

Errors

Every error is typed JSON. Only a successful call is settled.

CodeHTTPWhen
invalid_input400The body does not match the schema on this page. Nothing is charged. The body does not match the schema; its fields are url and max_chapters.
blocked_target403The destination is refused by the network guard: a disallowed address, or, for HTTP requests, a scheme other than http/https, a port other than 80/443, or credentials in the URL.
unreachable_target424The destination you named did not resolve or refused the connection.
upstream_timeout424The destination you named did not answer before the declared timeout for this endpoint expired.
unsupported_content_type415The destination returned a type this endpoint does not handle. The source is not a type epub-to-text reads; it reads EPUB.
too_large413The response exceeded the size cap while streaming, or decompressed at more than the allowed ratio.
unprocessable422The bytes arrived but could not be processed, for instance a malformed document.
internal500Our fault, and in almost every case nothing is charged. The exceptions come after the call has run and the settlement call was made: the message "The work was done but settlement could not be completed", and the messages starting with "Payment settlement returned". There, whether the payment moved is unknown to us as well. The payment moves at most once: its nonce is single-use and settlement is idempotent, so a retry with it is never charged twice. A retry is normally refused with a 402: replay_consumed, an expiry reason, or a reason saying the nonce was already used once the transfer is on-chain. Only if our server restarted before the transfer was final can a retry run the call again. Even then, the payment moves at most once. To see whether it was settled, read the EIP-3009 authorizationState of its nonce on-chain; to call again, sign a new payment.
rate_limited429Too many calls from the same payer, or too many calls towards the same destination domain. Nothing is charged.
concurrency_limit,
registry_at_capacity,
upstream_unavailable
503We could not serve the call right now. Retryable: wait the number of seconds in the retry-after header, then repeat the call. concurrency_limit and registry_at_capacity mean we were at capacity: the call did not run. You can send the same payment again if its validBefore is still far enough away to cover another call. If it is not, the retry gets a 402 authorization_validity_too_short: sign a new payment. upstream_unavailable means our internal service failed or did not answer in time: the call may already have run and the payment may have been settled. A retry with the same payment can get a 402 whose error field says why. authorization_validity_too_short: too little time is left before validBefore to cover another call. This check comes before the replay check, so it does not tell whether the first payment was settled. replay_consumed (the payment was used and may have been settled) or replay_exhausted (too many attempts): sign a new payment. replay_in_flight: the first call is still running, so wait and do not pay again. invalid_exact_evm_nonce_already_used: the transfer is already on-chain, so this payment cannot move again. Sign a new payment. An authorization can be settled only once, since its nonce is single-use. To see whether it was settled, read the EIP-3009 authorizationState of its nonce on-chain.
misconfigured503The service is not configured to serve calls. The call did not run and nothing is charged. It needs a fix on our side, so there is no retry delay to wait for.

Input that is rejected before the tool runs (malformed JSON, schema mismatch, body over the size limit) is never charged.

Conversions

Ready-made calls to this API, one page each.

ConversionRecorded sampleSourceOutput
EPUB to plain textdocuments/seed-saving.epub2.4 KB441 bytes

Questions

How much does a call to the EPUB to Text API cost?

$0.005 per call, paid in USD Coin on Base via x402. There is no account and no API key: the price is in the 402 answer, before anything is paid.

What is the timeout of epub-to-text?

The endpoint itself runs for at most 45 s. max_timeout_seconds in the 402 answer is 66: that covers the whole call, including payment verification and settlement around it.

How large can a response from epub-to-text be?

The response-size cap is 25 MB (26,214,400 bytes).

Is the epub-to-text input schema free to read?

Yes. GET https://grist.tools/v1/epub-to-text/schema returns the input schema for free, paid endpoints included.

What happens if a call to epub-to-text fails?

The payment is verified before the handler runs and settled only after it succeeds, so a call refused by the gate, or one that fails inside the handler, is never settled. The single case that cannot be stated in advance is a settlement call that fails without answering: the error message says so when that is what happened.

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.