SDKS
Official SDKs to add StartOCR to your app.
Python
pip install startocr
TypeScript
npm install @startocr/sdk
REST
Use any HTTP client
const client = new StartOCR({ apiKey: process.env.STARTOCR_API_KEY })
await client.markdown.create({ file: report })Typed responses · Upload helpers · Jobs · Retries
CAPABILITY MATRIX
Choose the client that fits your stack.
| Feature | Python | TypeScript | REST |
|---|---|---|---|
| OCR | |||
| Markdown | |||
| Extract | |||
| Jobs | |||
| Batch |
FIRST REQUEST
Install, initialize, parse.
Both official SDKs follow the same short path: add a key, upload a file, read the result.
1. Install
Use pip or npm in your application project.
pip install startocr
2. Initialize
Read the API key from a server-side environment variable.
STARTOCR_API_KEY
3. Parse
Call the endpoint that matches your output.
client.markdown.create
SDK SUPPORT
Know what ships with the client.
Use the REST API whenever you need a language we do not yet maintain.
Python
Uploads, OCR, Markdown, JSON, jobs, and retries.
PYTHON
TypeScript
Typed responses, uploads, jobs, and retries.
TYPESCRIPT
REST
The same endpoints work with any HTTP client.
OPENAPI