docexdev

Agent-first document extraction SDK and CLI. Extract structured data from PDFs, images, and scanned documents with a single API call.

Install

npm install docexdev

Quick start

SDK

import { createDocex } from "docexdev";

const docex = createDocex({
  apiKey: process.env.DOCEX_API_KEY,
  baseUrl: process.env.DOCEX_BASE_URL,
});

const result = await docex.extract({
  file: "invoice.pdf",
  prompt: "Extract line items, totals, and vendor details.",
});

console.log(result);

CLI

# Interactive setup — authenticates via GitHub and provisions an API key
docex setup --use-case "invoice extraction" --top-up 5

# Extract structured data from a document
docex extract invoice.pdf --prompt "Extract line items and totals"

# Check your wallet balance
docex wallet

# List extraction jobs
docex jobs list

# Get a specific job
docex jobs get <jobId>

# View the provider trace for a job
docex jobs trace <jobId>

# Accept or correct an extraction
docex verify <jobId> --accept
docex verify <jobId> --corrections corrections.json
docex verify <jobId> --interactive

# Usage and billing
docex usage --since 2025-01-01
docex billing status
docex billing top-up --amount 10

Use --json on any command to get machine-readable output. Use --api-key and --base-url to override environment variables.

Environment variables

| Variable | Description | |---|---| | DOCEX_API_KEY | Your API key (from docex setup) | | DOCEX_BASE_URL | API base URL (defaults to http://localhost:4000) |

SDK methods

| Method | Description | |---|---| | extract({ file, prompt, outputFormat?, docTypeHint?, workflow?, metadata? }) | Run an extraction | | verify(jobId, payload) | Accept or correct an extraction result | | whoami() | Get current workspace info | | wallet() | Get wallet balance | | jobs() | List extraction jobs | | job(jobId) | Get a single job | | jobTrace(jobId) | Get the provider trace for a job | | usage({ since? }) | Get usage stats | | billingStatus() | Get billing status | | createBillingTopUpSession({ amountUsd }) | Start a wallet top-up session |

License

MIT