API overview
Keys, one-shot translate and the full pipeline over HTTP — with the interactive reference at /api.
6 min read
Jokai exposes its whole pipeline over a REST API: translate a single image in one call, or drive projects, chapters, page uploads and renders from your own tools. This page is the 5-minute tour — the interactive reference with request builder, live code generation and a Try-it runner lives at /api.
Create an API key
API keys live in Settings → API. A key is shown once at creation and stored only as a hash — treat it like a password. Optional expiry, immediate revocation, and per-key rate limiting are built in.
One-shot translate
The fastest integration: POST an image with a target language, receive translated blocks with bounding boxes, the cleaned image and the final composed image — one synchronous call. Steer it with a custom prompt and story context, or pick a specific model.
- 1Create a key in Settings → API
- 2Open the /api reference and configure the request builder
- 3Copy the generated snippet in your language — or hit Try it
- 4Consume credits exactly like the app (BYOK translation is free)
The full pipeline
Beyond one-shot, the API mirrors the app: create a project, add chapters, upload pages, dispatch OCR and translation, then poll status or subscribe to webhooks for every stage. Exports and final renders are available the same way.
Every response carries X-Jokai-Credits — your live balance.