TypeScript SDK

npm install @outcrawl/sdk

import { Outcrawl } from '@outcrawl/sdk';

const oc = new Outcrawl(); // reads OUTCRAWL_API_KEY; pass { apiKey } to override

const doc = await oc.scrape('https://example.com', { formats: ['markdown'] });
console.log(doc.usage); // every call returns what it cost, on the result that caused it

const doc = await oc.scrape('https://example.com', { formats: ['markdown'] });

for await (const page of await oc.crawl('https://example.com')) {
  console.log(page.url, page.markdown);
}

const results = await oc.search('outcrawl');

const profile = await oc.profiles.create({ label: 'demo-user-42' }); // minted once, reused by id
const browser = await oc.browser({ profile: profile.id });           // its cookies and logins persist
const page = await browser.newPage();
await page.goto('https://practicetestautomation.com/practice-test-login/'); // a public demo login
await page.fill('#username', 'student');     // human input model, the default
await page.fill('#password', 'Password123');
await page.click('#submit');
await page.raw.waitForURL('**/logged-in-successfully/');
console.log(await page.title());             // "Logged In Successfully | Practice Test Automation"
await browser.close();

const run = oc.agent({
  task: 'Report the title of the top story on Hacker News.',
  caps: { budget: '16.00' },
});
const result = await run;         // await for the settled result
console.log(result.data);
for await (const step of run) {}  // or iterate the event log, both on one job is fine

const typed = await oc.agent({
  task: 'Report the title of the top story on Hacker News.',
  caps: { steps: 20, budget: '16.00', duration: '5m' },
  schema: { type: 'object', properties: { title: { type: 'string' } }, required: ['title'] },
});
if (typed.status === 'completed') console.log(typed.data); // { title: '...' }
else console.log(typed.status, typed.stopReason);          // capped, partial or failed: data may be absent