SDKs & Libraries

Official client libraries wrap the InkScan REST API with typed interfaces and handle authentication, base64 encoding, and error handling automatically.

Python

pip install inkscan

from inkscan import InkScan

client = InkScan(api_key="isk_live_...")

result = client.recognize("handwritten-notes.jpg")
print(result.text)
print(result.markdown)

# Batch processing via async jobs
job = client.create_job("multi-page.pdf")
job.wait()
for page in job.results:
    print(page.text)

Node.js / TypeScript

npm install @inkscan/sdk

import { InkScan } from "@inkscan/sdk";

const client = new InkScan({ apiKey: "isk_live_..." });

const result = await client.recognize("handwritten-notes.jpg");
console.log(result.text);
console.log(result.markdown);

// Batch processing via async jobs
const job = await client.createJob("multi-page.pdf");
const completed = await job.wait();
for (const page of completed.results) {
  console.log(page.text);
}

Go

go get github.com/inkscan/inkscan-go

package main

import (
    "fmt"
    "github.com/inkscan/inkscan-go"
)

func main() {
    client := inkscan.NewClient("isk_live_...")

    result, err := client.Recognize("handwritten-notes.jpg", nil)
    if err != nil {
        panic(err)
    }

    fmt.Println(result.Text)
    fmt.Println(result.Markdown)
}

REST API (cURL)

No SDK needed — use the REST API directly. See the Quickstart for examples.

Note: SDKs are coming soon. The REST API is fully functional today. Join the waitlist to get notified when SDKs ship.