Deep Research

# Stream progress and report text in real-time
curl -X POST https://api.webpeel.dev/v1/deep-research \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: text/event-stream" \
  -d '{
    "question": "What are the current state and limitations of quantum computing?",
    "llm": { "provider": "openai", "apiKey": "sk-..." },
    "stream": true
  }'

# Example SSE output:
# data: {"eventType":"progress","type":"decomposing","message":"Decomposing question...","round":0}
# data: {"eventType":"progress","type":"searching","message":"Searching: quantum computing 2025","round":0}
# data: {"type":"chunk","text":"## Executive Summary\n\n"}
# data: {"type":"done","sourcesUsed":12,"roundsCompleted":3,...}

const response = await fetch('https://api.webpeel.dev/v1/deep-research', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.WEBPEEL_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    question: 'What are the current state and limitations of quantum computing?',
    llm: {
      provider: 'openai',
      apiKey: process.env.OPENAI_API_KEY,
      model: 'gpt-4o-mini',
    },
    maxRounds: 3,
    maxSources: 20,
  }),
});

const data = await response.json();

console.log(data.report);            // Full markdown report
console.log(data.citations.length);  // Number of cited sources
console.log(`${data.sourcesUsed} sources, ${data.roundsCompleted} rounds, ${data.elapsed}ms`);

import { createParser } from 'eventsource-parser';

const response = await fetch('https://api.webpeel.dev/v1/deep-research', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.WEBPEEL_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    question: 'What is the current state of quantum computing?',
    llm: { provider: 'openai', apiKey: process.env.OPENAI_API_KEY },
    stream: true,
  }),
});

let report = '';
const parser = createParser((event) => {
  if (event.type !== 'event') return;
  const data = JSON.parse(event.data);

  if (data.eventType === 'progress') {
    process.stdout.write(`[${data.type}] ${data.message}\n`);
  } else if (data.type === 'chunk') {
    process.stdout.write(data.text);
    report += data.text;
  } else if (data.type === 'done') {
    console.log(`\n\nDone: ${data.sourcesUsed} sources, ${data.elapsed}ms`);
    console.log('Citations:', data.citations.length);
  } else if (data.type === 'error') {
    console.error('Error:', data.message);
  }
});

const reader = response.body.getReader();
const decoder = new TextDecoder();
while (true) {
  const { done, value } = await reader.read();
  if (done) break;
  parser.feed(decoder.decode(value));
}

import requests, os

response = requests.post(
    'https://api.webpeel.dev/v1/deep-research',
    headers={
        'Authorization': f'Bearer {os.environ["WEBPEEL_API_KEY"]}',
        'Content-Type': 'application/json',
    },
    json={
        'question': 'What are the current state and limitations of quantum computing?',
        'llm': {
            'provider': 'openai',
            'apiKey': os.environ['OPENAI_API_KEY'],
            'model': 'gpt-4o-mini',
        },
        'maxRounds': 3,
        'maxSources': 20,
    },
    timeout=120,  # deep research can take 30-90s
)

data = response.json()
print(data['report'])
print(f"\n{data['sourcesUsed']} sources, {data['roundsCompleted']} rounds, {data['elapsed']}ms")
print(f"Citations: {len(data['citations'])}")
for cite in data['citations']:
    print(f"  [{cite['index']}] {cite['title']} — {cite['url']}")

import requests, json, os

with requests.post(
    'https://api.webpeel.dev/v1/deep-research',
    headers={
        'Authorization': f'Bearer {os.environ["WEBPEEL_API_KEY"]}',
        'Content-Type': 'application/json',
    },
    json={
        'question': 'What is the current state of quantum computing?',
        'llm': {'provider': 'openai', 'apiKey': os.environ['OPENAI_API_KEY']},
        'stream': True,
    },
    stream=True,
    timeout=120,
) as resp:
    report_parts = []
    for line in resp.iter_lines():
        if not line or not line.startswith(b'data: '):
            continue
        event = json.loads(line[6:])
        if event.get('eventType') == 'progress':
            print(f"[{event['type']}] {event['message']}")
        elif event.get('type') == 'chunk':
            print(event['text'], end='', flush=True)
            report_parts.append(event['text'])
        elif event.get('type') == 'done':
            print(f"\n\nComplete: {event['sourcesUsed']} sources, {event['elapsed']}ms")
        elif event.get('type') == 'error':
            print(f"Error: {event['message']}")

report = ''.join(report_parts)