read_result

# 1. A scrape whose JSON exceeded max_inline_chars (default 40,000) came back
#    with a preview instead of the markdown:
#      "truncated": true,
#      "result_handle": "res_9f2c1e6a-4b7d-4c3e-8a5f-1d2e3f4a5b6c",
#      "total_chars": 182406

# 2. Search the stored result for the section you need (1 credit)
curl -X POST https://crawlforge.dev/api/v1/tools/read_result \
  -H "X-API-Key: cf_test_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "handle": "res_9f2c1e6a-4b7d-4c3e-8a5f-1d2e3f4a5b6c",
    "operation": "search",
    "query": "rate limits",
    "max_matches": 5
  }'

# 3. Read the section at the first match offset (1 credit) — no second fetch
curl -X POST https://crawlforge.dev/api/v1/tools/read_result \
  -H "X-API-Key: cf_test_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "handle": "res_9f2c1e6a-4b7d-4c3e-8a5f-1d2e3f4a5b6c",
    "operation": "slice",
    "offset": 18240,
    "length": 4000
  }'

// npm install crawlforge-sdk
import { CrawlForge } from 'crawlforge-sdk';

const client = new CrawlForge({ apiKey: process.env.CRAWLFORGE_API_KEY });

// 1. Scrape a long page. Over max_inline_chars (default 40,000 characters of
//    JSON) the markdown is replaced by a preview and a result_handle.
const page = await client.scrape({
  url: 'https://example.com/docs/api',
  formats: ['markdown'],
});

// page.data is untyped in crawlforge-sdk 0.1 — a truncated result carries the
// handle fields shown in the cURL tab instead of the markdown.
const scraped = page.data as
  | { truncated: true; result_handle: string; total_chars: number }
  | { truncated?: false; formats: { markdown: string } };

if (scraped.truncated) {
  const { result_handle, total_chars } = scraped;
  console.log('Stored ' + total_chars + ' characters as ' + result_handle);

  // 2. Search the stored markdown for the section you need (1 credit).
  const found = await client.readResult({
    handle: result_handle,
    operation: 'search',
    query: 'rate limits',
    max_matches: 5,
  });

  // result.data is untyped in crawlforge-sdk 0.1 — its shape is the Response Example below.
  const { matches } = found.data as { matches: { offset: number }[] };

  // 3. Slice from the first match offset (1 credit) — no second fetch.
  const [first] = matches;
  if (first) {
    const section = await client.readResult({
      handle: result_handle,
      operation: 'slice',
      offset: first.offset,
      length: 4000,
    });
    const { text, has_more } = section.data as { text: string; has_more: boolean };
    console.log(text);
    console.log('More after this slice:', has_more);
  }
} else {
  console.log(scraped.formats.markdown); // small enough to arrive inline
}

# pip install crawlforge
from crawlforge import CrawlForge

client = CrawlForge()  # reads CRAWLFORGE_API_KEY

# 1. Scrape a long page. Over max_inline_chars (default 40,000 characters of
#    JSON) the markdown is replaced by a preview and a result_handle.
page = client.scrape(url='https://example.com/docs/api', formats=['markdown'])

# result.data is a plain dict — its shape is the Response Example below.
if page.data.get('truncated'):
    handle = page.data['result_handle']
    print(f"Stored {page.data['total_chars']} characters as {handle}")

    # 2. Search the stored markdown for the section you need (1 credit).
    found = client.read_result(
        handle=handle,
        operation='search',
        query='rate limits',
        max_matches=5,
    )

    # 3. Slice from the first match offset (1 credit) - no second fetch.
    if found.data['matches']:
        first = found.data['matches'][0]
        section = client.read_result(
            handle=handle,
            operation='slice',
            offset=first['offset'],
            length=4000,
        )
        print(section.data['text'])
        print('More after this slice:', section.data['has_more'])
else:
    print(page.data['formats']['markdown'])  # small enough to arrive inline