SDK quickstart

npm install https://install.webcompute.dev/sdk/latest.tgz

export WEBCOMPUTE_API_KEY=wc_key_your_key_here
export OPENROUTER_API_KEY=your_provider_key

import { Web } from "@webcompute/sdk";

const web = new Web();

const agent = web.agent({
  model: {
    route: "openrouter",
    model: "openai/gpt-5.4-mini",
    apiKeyEnv: "OPENROUTER_API_KEY",
  },
  browser: {
    create: { recording: true },
    policy: { allowedDomains: ["sec.gov"] },
  },
  approval: "ask",
});

const result = await agent.run({
  startUrl: "https://www.sec.gov/edgar/search/",
  goal:
    "Find Apple's latest 10-Q filings. Return filing date, accession number, filing URL, and a one-sentence summary.",
});

if (result.status !== "completed") {
  throw new Error(result.error?.message ?? `Agent run ended with ${result.status}`);
}

console.log(result.text);
console.log(result.browserId);

await agent.run("Open the pricing page and summarize enterprise plan differences.");

console.log(result.status);
console.log(result.text);
console.log(result.steps.length);
console.log(result.artifacts);

const resourceAgent = web.agent({
  model: {
    route: "openrouter",
    model: "openai/gpt-5.4-mini",
    apiKeyEnv: "OPENROUTER_API_KEY",
  },
  approval: "ask",
});

const browser = await web.browser.create({
  recording: true,
  policy: { allowedDomains: ["vendor.example"] },
});

try {
  const result = await resourceAgent.run({
    browserId: browser.id,
    startUrl: "https://vendor.example/dashboard",
    goal: "Find the latest paid invoice and download the PDF.",
  });

  if (result.status !== "completed") {
    throw new Error(result.error?.message ?? `Run ended with ${result.status}`);
  }

  const downloads = await browser.downloads.list();
  const [invoice] = downloads.data;
  if (invoice) await browser.downloads.save(invoice.id, "./invoice.pdf");
} finally {
  await browser.close();
}

const session = await agent.session({
  startUrl: "https://www.sec.gov/edgar/search/",
});

try {
  await session.run("Find Apple's latest 10-Q filing.");
  const comparison = await session.run("Compare it with the previous 10-Q filing.");
  console.log(comparison.text);
} finally {
  await session.close();
}