Docs

ReportLens API

ReportLens is a specialized service for generating comprehensive, structured reports. It performs extensive research and compiles the findings into a downloadable Markdown document.

Generate Report

Trigger the report generation process. Returns a URL to the generated file upon completion.

POST/reportlens/research

Request Body

payload.json

{
  "query": "string",
  "settings": {
    "max_results": 12,      // Optional.
    "iteration_depth": 4    // Optional. Depth of research.
  }
}

Example Request

curl.sh

curl -X POST "https://api.tekkscope.com/reportlens/research" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Market analysis of electric vehicles in Europe 2024"
  }'

Response

response.json

{
  "result": {
    "summary": "Short summary of the report...",
    "download_url": "https://storage.tekkscope.com/reports/...",
    "formatted_findings": "# Full Markdown Content..."
  }
}

Stream Report Generation

Monitor the report creation progress. The final message usually contains the download URL.

GET/reportlens/research/stream

Query Parameters

query (string) - Required

Example Request

stream.js

const eventSource = new EventSource(
  "https://api.tekkscope.com/reportlens/research/stream?query=ev+market+analysis&token=YOUR_API_KEY"
);

eventSource.onmessage = (event) => {
  const data = JSON.parse(event.data);
  
  if (data.type === "thinking") {
    console.log("Status:", data.content.phase);
  } else if (data.type === "response") {
    // Checks if content is a URL
    if (data.content.startsWith("http")) {
        console.log("Download Report:", data.content);
    } else {
        // Or partial content updates
        console.log("Content:", data.content);
    }
  }
};