API Documentation

Integrate E-Ink ebook conversion services into your applications

Use with AI Agents — Zero Setup

Copy the prompt below and paste it into Cursor, Claude Code, Codex, or any AI coding agent to install automatically.

Install the E-Ink skill: run npx e-ink-skill, then set the env var EINK_API_KEY to my API key.

Works with Cursor, Claude Code, Windsurf, Codex, and more.

More installation methods

Getting Started

To use the E-Ink API, you need an API key. Create one from your Dashboard, then include it in the Authorization header of your requests.

Authentication

All API requests must include your API key in the Authorization header:

Authorization: Bearer eink_your_api_key_here

Base URL

https://e-ink.me/api/v1

Credits System

API calls consume credits from your account, same as using the web interface.

APICredit Cost
Webpage to Ebook3(per URL)
File Format Conversion2 / 5(PDF OCR: 5)
Ebook Translation3(per file)
Text to Speech5(per file)
Mind Map Generation2 / 5(AI: 5)

API Endpoints

GET/api/v1/credits

Check Credits Balance

Returns your current credit balance.

0 credits
curl
curl https://e-ink.me/api/v1/credits \
  -H "Authorization: Bearer eink_your_api_key"
Response
{
  "credits": 150
}
POST/api/v1/convert/webpage

Webpage to Ebook

Convert one or more web pages to EPUB, PDF, or Markdown format.

3 credits per URL
curl
curl -X POST https://e-ink.me/api/v1/convert/webpage \
  -H "Authorization: Bearer eink_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://e-ink.me", "format": "epub"}' \
  -o article.epub
POST/api/v1/convert

File Format Conversion

Convert files between EPUB, PDF, Markdown, HTML, DOCX, TXT, and more. Send a multipart form with the file and converter ID.

2 / 5 credits
curl
curl -X POST https://e-ink.me/api/v1/convert \
  -H "Authorization: Bearer eink_your_api_key" \
  -F "file=@book.epub" \
  -F "converter=epub-to-pdf" \
  -o book.pdf
POST/api/v1/convert/translate

Ebook Translation

Translate an EPUB file to another language. Send a multipart form with the EPUB file, target language, and optional source language.

3 credits per file
curl
curl -X POST https://e-ink.me/api/v1/convert/translate \
  -H "Authorization: Bearer eink_your_api_key" \
  -F "file=@book.epub" \
  -F "targetLanguage=Chinese" \
  -F "sourceLanguage=auto" \
  -o book-translated.epub
POST/api/v1/convert/tts

Text to Speech

Convert text to speech audio (MP3 format).

5 credits per file
curl
curl -X POST https://e-ink.me/api/v1/convert/tts \
  -H "Authorization: Bearer eink_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"input": "Hello, this is a test.", "voice": "en-US-JennyNeural"}' \
  -o speech.mp3
POST/api/v1/convert/mindmap

Mind Map Generation

Generate a mind map from an EPUB or PDF file. Send a multipart form with the file, mode, and export format.

2 / 5 credits
curl
curl -X POST https://e-ink.me/api/v1/convert/mindmap \
  -H "Authorization: Bearer eink_your_api_key" \
  -F "file=@book.epub" \
  -F "mode=structure" \
  -F "format=freemind"
Response
{
  "tree": { "label": "Book Title", "children": [...] },
  "stats": { "nodeCount": 42, "maxDepth": 4 },
  "files": {
    "freemind": "<map>...</map>",
    "opml": "<?xml ...?>...",
    "markdown": "# Book Title\n## Chapter 1\n..."
  }
}

Error Codes

CodeDescription
400Bad Request — Invalid parameters
401Unauthorized — Missing or invalid API key
402Payment Required — Insufficient credits
413Payload Too Large — File exceeds size limit
500Internal Server Error — Something went wrong

AI Agent Skill

Use E-Ink directly in Cursor, Claude Code, Codex, and other AI coding agents through our Agent Skill. Convert web pages, translate ebooks, and more — all from your editor.

Installation

1

Tell your AI agent

Recommended

Copy this prompt and paste it into your AI agent's chat. It will handle the installation for you.

Install the E-Ink skill: run npx e-ink-skill, then set the env var EINK_API_KEY to my API key.
2

Run npx manually

npx
npx e-ink-skill
3

Clone from GitHub

git clone
# Cursor
git clone https://github.com/Selenium39/e-ink-skill.git ~/.cursor/skills/e-ink-skill

# Claude Code / Codex
git clone https://github.com/Selenium39/e-ink-skill.git ~/.claude/skills/e-ink-skill

Set your API key as an environment variable:

export EINK_API_KEY="eink_your_api_key_here"

The skill is now available in your AI agent. Try asking:

“Convert https://e-ink.me to EPUB”
“Translate this EPUB to Chinese”
“Check my E-Ink credits balance”
View on GitHub