developer docs

Get started

Introduction

Upload chapters to tinypica from your own tools, and hear back when they are translated.

The tinypica API does over HTTP what your team does in the dashboard: it puts a chapter into one of your projects, runs its pages through the project's steps and languages, and hands back the translated file. Webhooks tell your server when a chapter is done, so nothing has to keep asking.

It is for scanlation groups and publishers who already have a pipeline of their own: a scraper that fetches raws, a CMS that publishes chapters, a script run every night.

What the API does

  • Uploads. A comic chapter as its page images, one request per page or all at once. A novel chapter as its text.
  • Runs. Text extraction, translation, page cleaning and lettering, as far as the project goes, into every language the project translates into.
  • Status. Whether a chapter is still running, whether it failed and why, and how far each language got.
  • Files. Finished pages as a zip, cleaned pages, and the script as plain text or a Word document.
  • Webhooks. A signed POST to your server when a chapter finishes or fails, and when each file is ready.

What stays in the dashboard

Projects are set up in the dashboard, and the API works inside them: which languages a project translates into, its translation model, how far its pages are taken and its glossary are all the project's, not the upload's. Editing a translation, billing and the team stay in the dashboard too. A chapter uploaded over the API shows up there like any other, and anyone on the team can review it.

How it fits together

  1. A workspace owner creates an API key, and a webhook endpoint if you want one, on the API screen.
  2. Your tool creates a chapter in a project and uploads its pages, then starts the run.
  3. tinypica reads the text on every page, translates it, erases the original lettering and letters the translation in, as far as the project's steps go.
  4. Your endpoint is sent chapter.finished, and export.ready for each file the run packaged.
  5. Your tool downloads the file.

The quickstart does all five with curl.

Base URL

Base URL
https://tinypica.com/api/v1

Every request goes over HTTPS and carries an API key. Answers are JSON, times are ISO 8601 in UTC, and ids are UUIDs. A request the API refuses answers with a status and a sentence saying why: see errors and limits.

Your first request

With a key in TINYPICA_KEY, list the workspace's projects:

Shell
curl https://tinypica.com/api/v1/projects \
  -H "Authorization: Bearer $TINYPICA_KEY"

The answer, shortened:

JSON
[
  {
    "id": "0cf217a0-c404-4fd7-8732-5f83b9e766ca",
    "name": "Pepper & Carrot",
    "kind": "comic",
    "sourceLanguage": "fr",
    "processSteps": "full",
    "targetLanguages": [
      { "languageCode": "en", "addedAt": "2026-09-28T12:46:50.445Z" },
      { "languageCode": "es", "addedAt": "2026-09-28T12:46:50.459Z" }
    ],
    "chapterCount": 12,
    "createdAt": "2026-09-28T12:46:50.415Z"
  }
]

What it costs

The API is on every plan, and calling it is free. Running pages costs the same credits it does in the dashboard, and exports are free, as they are there. See pricing.