# npm
npm install @ocriva/sdk
 
# pnpm
pnpm add @ocriva/sdk
 
# yarn
yarn add @ocriva/sdk

import { OcrivaClient } from '@ocriva/sdk';
import { readFileSync } from 'node:fs';
 
const client = new OcrivaClient({
  apiKey: process.env.OCRIVA_API_KEY!,
});
 
// 1. Read a local file into a Buffer
const buffer = readFileSync('./invoice.pdf');
 
// 2. Upload the file for OCR processing
const upload = await client.upload.file(buffer, {
  fileName: 'invoice.pdf',
  fileType: 'pdf',
  fileSize: String(buffer.byteLength),
  mimeType: 'application/pdf',
  projectId: 'proj_abc123',
  templateId: 'tmpl_xyz789', // optional — apply an extraction template
});
 
console.log('Upload ID:', upload.id);
console.log('Status:', upload.status); // 'uploaded' | 'processing' | ...
 
// 3. Poll processing history until the job finishes
let record = await client.processingHistory.get(upload.id, 'proj_abc123');
 
while (record.status === 'pending' || record.status === 'queued' || record.status === 'in_progress') {
  await new Promise((resolve) => setTimeout(resolve, 2000));
  record = await client.processingHistory.get(upload.id, 'proj_abc123');
}
 
if (record.status === 'completed') {
  // 4. Download the extracted result as JSON
  const blob = await client.processingHistory.getResult(record.id, {
    format: 'json',
    projectId: 'proj_abc123',
  });
 
  const text = await blob.text();
  console.log('Extracted data:', JSON.parse(text));
} else {
  console.error('Processing failed:', record.errorMessage);
}

import { OcrivaClient } from '@ocriva/sdk';
 
const client = new OcrivaClient({
  apiKey: 'ocr_live_...',       // required
  baseUrl: 'https://api.ocriva.com/v1', // default
  timeout: 30_000,              // 30 s, in milliseconds
  maxRetries: 3,                // retries on 429 and 5xx responses
});