Skip to main content

Installation

npm install parsefy zod
  • parsefy: Parsefy SDK for document extraction
  • zod: TypeScript-first schema validation library

Setup

Set your API key as an environment variable:
export PARSEFY_API_KEY=pk_your_api_key

Extract your first document

import { Parsefy } from 'parsefy';
import * as z from 'zod';

const client = new Parsefy();

const schema = z.object({
  invoice_number: z.string().describe('The invoice number'),
  date: z.string().describe('Invoice date'),
  total: z.number().describe('Total amount'),
  vendor: z.string().describe('Vendor name'),
});

const { object, error } = await client.extract({
  file: './invoice.pdf',
  schema,
});

if (!error) {
  console.log(object);
}

Next steps