API

VL-first local primitives, one product surface.

The local package API is intentionally small. The supported public import surface is the root package plus @echofiles/echo-pdf/local, both centered on render, page understanding, semantic structure, and workspace artifacts.

Primitive	Returns	Writes	Primary use
`get_document`	document metadata	`document.json`	source snapshot and document root
`get_document_structure`	stable page index	`structure.json`	iterate pages and locate page artifacts
`get_semantic_document_structure`	heading tree + cross-page tables, formulas, figures	`semantic-structure.json`	chapter navigation plus merged structured elements without mutating `pages[]`; requires provider + model
`get_page_content`	page text artifact	`pages/<page>.json`	page retrieval and semantic input
`get_page_render`	render metadata	`renders/<page>.json` + PNG	visual page reuse and VL input
`get_page_tables_latex`	LaTeX tabular artifacts	`tables/<page>...json`	structured table extraction; requires provider + model
`get_page_formulas_latex`	LaTeX math artifacts	`formulas/<page>...json`	displayed formula extraction; requires provider + model
`get_page_understanding`	tables + formulas + figures	`understanding/<page>...json`	combined single-page extraction in one LLM call; requires provider + model

Import surface

import {
  get_document,
  get_document_structure,
  get_semantic_document_structure,
  get_page_content,
  get_page_render,
  get_page_tables_latex,
  get_page_formulas_latex,
  get_page_understanding,
} from "@echofiles/echo-pdf/local"

Provider-backed semantic call

const semantic = await get_semantic_document_structure({
  pdfPath: "./sample.pdf",
  provider: "ollama",
  model: "llava:13b",
})

Runtime expectation

Node.js >=20
ESM import support
local-first Node/Bun runtime
package exports aware consumer
get_semantic_document_structure requires provider and model parameters or configured defaults
that provider may be a local OpenAI-compatible endpoint via baseUrl: "http://127.0.0.1:..."

Not the place for broad tool sprawl.

This reference is intentionally centered on the main VL-first primitives. Worker, MCP, and hosted-service entrypoints are not part of the supported package surface.