TypeScript SDK Guide

npm install @anyformat/sdk

import { Anyformat } from "@anyformat/sdk";

// Explicit
const af = new Anyformat({ apiKey: "af_..." });

// Or from the environment, under Node
const af2 = new Anyformat({ apiKey: process.env.ANYFORMAT_API_KEY! });

import { Anyformat, Schema } from "@anyformat/sdk";

const af = new Anyformat({ apiKey: process.env.ANYFORMAT_API_KEY! });
const file: File = /* a File with .name set, as in new File([bytes], "invoice.pdf") */;

const workflow = await af
  .workflow("Invoice Processor", "Extract invoice header and totals")
  .parse()
  .extract([
    Schema.string("invoice_number", "The unique invoice identifier"),
    Schema.float("total_amount",    "Total invoice amount"),
    Schema.date("issue_date",       "Date when the invoice was issued"),
  ])
  .create();             // persists the workflow, returns a Workflow handle

const run = await workflow.run(file);   // submits the document
const result = await run.wait();        // polls /results/ until 200

console.log(result.field("invoice_number")?.value);
console.log(result.field("total_amount")?.value);

const result = await run.wait({ timeoutMs: 180_000, pollMs: 3_000 });

const workflow = await af
  .workflow("Invoice + vendor lookup")
  .parse()
  .extract(
    [
      Schema.string("vendor_name", "Vendor as printed on the invoice."),
      Schema.float("total", "Grand total amount."),
      Schema.string("vendor_id", "Canonical vendor code from the catalog, joined on vendor_name.", { source: "smart_lookup" }),
    ],
    {
      lookupFiles: ["vendor_catalog.csv"],
      lookupSuggestion: "Match the extracted vendor_name against the vendor_name column; return vendor_id.",
    },
  )
  .create();

const result = await workflow.run(file).wait();
console.log(result.field("vendor_id")?.value);   // resolved from the catalog

const workflows = await af.listWorkflows({ pageSize: 50 });
for (const wf of workflows) console.log(wf.id, wf.name);

const file = new File([/* bytes */], "invoice.pdf");
const run = await workflows[0].run(file);
const result = await run.wait();

await af.deleteWorkflow(workflows[0].id);

const result = await run.wait();

// Scalar fields, for a linear workflow with a single untagged extraction
const inv = result.field("invoice_number");
console.log(inv?.value, inv?.confidence, inv?.evidence);

// For anything else, such as nested objects, split workflows or
// classifications, read result.raw: the validated wire envelope.
const markdown = result.raw.parse?.markdown;
for (const extraction of result.extractions) {
  // Validate-node verdicts travel with the extraction they judged.
  for (const verdict of extraction.validations ?? []) {
    console.log(verdict.rule_id, verdict.status, verdict.severity, verdict.detail);
  }
  for (const [name, field] of Object.entries(extraction.fields)) {
    console.log(name, field);
  }
}

import {
  AnyformatError,   // base class
  APIError,         // every HTTP failure without a typed subclass
  BadRequest,       // 400: validation error or bad request body
  Unauthorized,     // 401: invalid or missing API key
  Forbidden,        // 403: disallowed by the server
  NotFound,         // 404: workflow, file or webhook does not exist
  RateLimited,      // 429: slow down
  ServerError,      // 5xx: internal anyformat error
  SDKTimeout,       // local timeout: wait() exceeded timeoutMs
  WorkflowBuilderError, // builder-API misuse, such as .extract() before .parse()
} from "@anyformat/sdk";

try {
  const workflow = await af.workflow("…").parse().extract([/* … */]).create();
  const run = await workflow.run(file);
  const result = await run.wait();
} catch (err) {
  if (err instanceof RateLimited) {
    // back off, retry
  } else if (err instanceof NotFound) {
    // workflow or file is gone
  } else if (err instanceof APIError) {
    console.error(`HTTP ${err.status}`, err.body);
  } else if (err instanceof SDKTimeout) {
    // polling deadline exceeded
  } else {
    throw err;
  }
}

const res = await fetch("https://api.anyformat.ai/v2/webhooks/", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.ANYFORMAT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    url: "https://your-server.com/hook",
    events: ["extraction.completed"],
  }),
});
const webhook = await res.json();
// webhook.secret comes back once. Store it.