Back to Home
Documentation

API Reference

Production-oriented endpoints for document lifecycle operations.

REST endpoints for uploads, processing jobs, status checks, and export data.

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

Authentication and Access

  • Use bearer tokens for protected routes and service role keys only in backend contexts.
  • Enforce RLS-compatible user scoping when reading jobs and extraction results.

Section 2

Core Endpoints

  • Upload endpoint for file intake and metadata creation.
  • Processing endpoint for OCR, classification, extraction orchestration.
  • Status endpoint for polling progress and failure reasons by stage.

Section 3

Error and Retry Model

  • Return explicit stage failures with actionable reasons for users and operators.
  • Retry only idempotent stages and preserve audit logs for every attempt.
Process a document
POST /api/processing/start
{
  "document_id": "doc_123",
  "mode": "invoice"
}