Skip to main content

Node.js SDK

The official Node.js SDK wraps the Parselyze API with a typed client for document parsing, jobs, templates, and webhooks.

Installation​

npm install parselyze

Setup​

Get your API key from the Parselyze dashboard.

import { Parselyze } from "parselyze";

const parselyze = new Parselyze("plz_your_api_key_here");

Quick Example​

import { Parselyze } from "parselyze";

const parselyze = new Parselyze(process.env.PARSELYZE_API_KEY);

// Recommended: submit for async processing
const job = await parselyze.documents.parseAsync({
  file: "./invoice.pdf",
  templateId: "YOUR_TEMPLATE_ID",
});

const result = await parselyze.jobs.get(job.jobId);
console.log(result.status, result.result);

What's Included​

  • parselyze.documents.parse() / parselyze.documents.parseAsync() — synchronous and asynchronous document parsing
  • parselyze.jobs.get() — poll an async job's status and result
  • parselyze.templates.list() / create() / update() / delete() — manage extraction templates
  • Full TypeScript types for requests and responses

See the source and full README on GitHub for the complete API surface.

Next Steps​

  • Review the API Reference for the underlying HTTP endpoints
  • Configure Webhooks to receive results without polling