Back to Home
Documentation

Getting Started

Launch your first complete document flow in minutes.

Set up NeuroDocs locally and run your first document processing flow.

Last updated: June 13, 20263 key sections
api-client.ts
import { neuro } from "docs";
// Initialize API client
const client = new NeuroDocs({
apiKey: "nd_live_...",
version: "2026-06"
});
await client.extract("doc_123");
STATUS: READY200 OK

Section 1

Environment Setup

  • Configure Supabase URL, anon key, and service key in backend and frontend env files.
  • Install Poppler and Tesseract so OCR and page-count parsing work for PDF files.

Section 2

Local Run Commands

  • Start backend API and frontend app in separate terminals.
  • Validate health routes, auth flow, and storage upload permissions before first demo.

Section 3

End-to-End Validation

  • Upload one PDF and one image, then confirm OCR text and extraction outputs.
  • Check status transitions so processing does not stall at high progress values.
Backend startup
uvicorn main:app --reload --host 0.0.0.0 --port 8000