Convert any document via API

# 1. Create an API key at scanheroai.com/settings/api-keys
# 2. Upload a PDF and get Markdown back in seconds

curl -X POST https://api.scanheroai.com/v1/tasks \
  -H "X-Api-Key: sh_your_key" \
  -F "file=@report.pdf" \
  -F 'options_json={"output_format":"markdown"}'

$ pip install scanhero

from scanhero import ScanHero

sh = ScanHero(api_key="sh_...")

# Small files return immediately
task = sh.tasks.create("report.pdf")
print(task.output_markdown)

# Large files are async — poll until done
task = sh.tasks.create("recording.mp4")
task = sh.tasks.wait(task.task_id)

# Refine with an LLM prompt
task = sh.tasks.adjust(task.task_id, "Summarise in bullet points")

# Download as DOCX
docx = sh.tasks.download(task.task_id, format="docx")
open("output.docx", "wb").write(docx)

$ npm install @scanhero/sdk

import { ScanHero } from "@scanhero/sdk";

const sh = new ScanHero({ apiKey: "sh_..." });
// or: const sh = ScanHero.fromEnv();  // reads SCANHERO_API_KEY

// Upload a PDF
const task = await sh.tasks.createTaskV1TasksPost({
  formData: {
    file: new Blob([pdfBytes], { type: "application/pdf" }),
    options_json: JSON.stringify({ output_format: "markdown" }),
  },
});

// Poll until done (large files)
let result = task;
while (result.status === "pending" || result.status === "processing") {
  await new Promise((r) => setTimeout(r, 2000));
  result = await sh.tasks.getTaskV1TasksTaskIdGet({ taskId: task.task_id });
}
console.log(result.output_markdown);

// Refine with an LLM prompt
await sh.tasks.adjustTaskV1TasksTaskIdAdjustPost({
  taskId: task.task_id,
  requestBody: { prompt: "Summarise in bullet points" },
});

// Profile and credit balance
const me = await sh.users.getMeV1UsersMeGet();
console.log(me.credits);

Python SDK

Official SDK with full type hints, automatic retry on 429/5xx, and built-in async polling. Built on httpx (single dependency).

from scanhero import ScanHero

sh = ScanHero(api_key="sh_...")

# Small files return immediately
task = sh.tasks.create("report.pdf")
print(task.output_markdown)

# Large files are async — poll until done
task = sh.tasks.create("recording.mp4")
task = sh.tasks.wait(task.task_id)

# Refine with an LLM prompt
task = sh.tasks.adjust(task.task_id, "Summarise in bullet points")

# Download as DOCX
docx = sh.tasks.download(task.task_id, format="docx")
open("output.docx", "wb").write(docx)

TypeScript / JavaScript SDK

Generated with openapi-typescript-codegen from the live OpenAPI spec. Every endpoint, model, and enum is typed. Works in Node.js and modern browsers.

import { ScanHero } from "@scanhero/sdk";

const sh = new ScanHero({ apiKey: "sh_..." });
// or: const sh = ScanHero.fromEnv();  // reads SCANHERO_API_KEY

// Upload a PDF
const task = await sh.tasks.createTaskV1TasksPost({
  formData: {
    file: new Blob([pdfBytes], { type: "application/pdf" }),
    options_json: JSON.stringify({ output_format: "markdown" }),
  },
});

// Poll until done (large files)
let result = task;
while (result.status === "pending" || result.status === "processing") {
  await new Promise((r) => setTimeout(r, 2000));
  result = await sh.tasks.getTaskV1TasksTaskIdGet({ taskId: task.task_id });
}
console.log(result.output_markdown);

// Refine with an LLM prompt
await sh.tasks.adjustTaskV1TasksTaskIdAdjustPost({
  taskId: task.task_id,
  requestBody: { prompt: "Summarise in bullet points" },
});

// Profile and credit balance
const me = await sh.users.getMeV1UsersMeGet();
console.log(me.credits);

Services are namespaced on the client: sh.tasks, sh.jobs, sh.webhooks, sh.templates, and more — mirroring the REST paths below.