Web Scraping & Search (totalum-sdk/web)

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

totalumWeb(options?: TotalumClientOptions): TotalumWeb

import { totalumWeb } from 'totalum-sdk/web';

const web = totalumWeb();
const page = await web.scrape('https://example.com');

web.scrape(url: string, opts?: { formats?, onlyMainContent?, waitFor?, timeout?, proxy?, location?, actions?, schema?, prompt?, cacheMaxAgeMs? }): Promise<WebScrapeOutput>

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

{
  "url": "https://example.com/",
  "statusCode": 200,
  "metadata": { "sourceURL": "https://example.com/", "title": "Example Domain", "language": "en" },
  "markdown": "# Example Domain\n\nThis domain is for use in documentation examples without needing permission. …",
  "usage": { "credits": 0.0343 }
}

// structured data with a JSON schema
const { json } = await totalum.web.scrape('https://shop.example.com/p/red-shoes', {
  formats: ['json'],
  schema: { type: 'object', properties: { name: { type: 'string' }, price: { type: 'number' } } },
});

{ "name": "Red running shoes", "price": 79.9 }

web.search(query: string, opts?: { limit?, location?, sources?, timeRange?, scrapeOptions? }): Promise<{ web, news?, images?, scraped?, usage }>

const results = await totalum.web.search('totalum app builder', { limit: 2 });

{
  "web": [
    {
      "title": "Totalum - The most powerful AI app builder for humans and for agents",
      "url": "https://www.totalum.app/en",
      "snippet": "Create any web or app. The first AI app builder you can use via API and MCP…",
      "position": 1
    },
    {
      "title": "Totalum Blog: AI app builder, AI coding agents, MCP guides",
      "url": "https://www.totalum.app/blog",
      "snippet": "An AI app builder that generates real code lets you export and own the source…",
      "position": 2
    }
  ],
  "usage": { "credits": 0.0685 }
}

web.map(url: string, opts?: { limit?, search? }): Promise<{ links, usage }>

const { links } = await totalum.web.map('https://docs.example.com', { search: 'pricing', limit: 5 });

{
  "links": ["https://docs.example.com/pricing", "https://docs.example.com/pricing/teams"],
  "usage": { "credits": 0.0343 }
}

web.crawl(url: string, opts?: { limit?, scrapeOptions?, maxDepth?, includePaths?, excludePaths?, webhook? }): Promise<JobCreated>

const { jobId } = await totalum.web.crawl('https://docs.example.com', { limit: 50, includePaths: ['/guides/.*'] });
// save jobId, then poll crawlStatus(jobId) later

{ "jobId": "01M4P1C8Z3X7Y2W5V9T6S4R0QA", "estimatedCredits": 1.716 }

web.crawlStatus(jobId: string): Promise<WebJob>

const job = await totalum.web.crawlStatus('01M4P1C8Z3X7Y2W5V9T6S4R0QA');
if (job.status === 'completed') for (const page of job.data) await savePage(page.url, page.markdown);

{
  "jobId": "01M4P1C8Z3X7Y2W5V9T6S4R0QA",
  "status": "completed",
  "total": 2,
  "completed": 2,
  "creditsUsed": 2,
  "data": [
    { "url": "https://docs.example.com/guides/start", "statusCode": 200, "metadata": { "sourceURL": "https://docs.example.com/guides/start", "title": "Getting started" }, "markdown": "# Getting started\n…" },
    { "url": "https://docs.example.com/guides/deploy", "statusCode": 200, "metadata": { "sourceURL": "https://docs.example.com/guides/deploy", "title": "Deploy" }, "markdown": "# Deploy\n…" }
  ]
}

web.cancelCrawl(jobId: string): Promise<WebJob>

const job = await totalum.web.cancelCrawl('01M4P1C8Z3X7Y2W5V9T6S4R0QA');

{ "jobId": "01M4P1C8Z3X7Y2W5V9T6S4R0QA", "status": "cancelled", "total": 50, "completed": 12, "creditsUsed": 12, "data": […] }

web.screenshot(input: ScreenshotInput): Promise<{ key, url, format, base64?, usage }>

const shot = await totalum.web.screenshot({
  html: '<div style="font:48px sans-serif;padding:40px">Launch day 🚀</div>',
  viewport: { width: 1200, height: 630 },
});

{
  "key": "p/acme-crm/01M4P0SFVZXNRS871ZSKZNWHY0.png",
  "url": "https://files.totalum-project.com/p/acme-crm/01M4P0SFVZXNRS871ZSKZNWHY0.png",
  "format": "png",
  "usage": { "credits": 0.0002 }
}