Skip to main content

1. Overview

The Industry Research API generates an end-to-end sector intelligence report on any industry or market, covering market sizing, growth drivers, competitive dynamics, innovation trends, and recent transaction activity. The report is fully source-cited and delivered as structured JSON or as a formatted document (PDF, DOCX, or PPT). This is an asynchronous POST API — submitting a request returns a report_id immediately. You then poll for completion using the Report Status endpoint and retrieve the finished report using the Download Report endpoint. The three-step workflow:
The completed report is structured into five major sections, each returned as a named key in the JSON output:
  • Executive Summary — multi-paragraph narrative covering market size, growth drivers, regional dynamics, technology trends, supply chain, and regulatory landscape; fully source-cited with 20–30+ references
  • Key Insights — 8–10 analyst-style insight cards, each with a headline metric, supporting data paragraph, and multi-point commentary with citations
  • Overview — structured description of the industry — definition, key offerings, market segments, and core problems the sector solves
  • Trends and Innovations — detailed synthesis of technological, operational, and strategic trends reshaping the industry, with named company examples and quantified data points
  • Select Transactions — fundraising activity data for companies in the space, including per-deal records with investor details, funding stage, and amounts; quarterly deal-count and total-funding charts; and a ranked list of key investors
Common use cases:
  • Thesis development for new sectors — generate a sourced, structured primer on any industry before committing diligence resources to it
  • LP and IC briefing decks — export as PPT or PDF for sector updates, investment committee presentations, or fund strategy reviews
  • Market entry and expansion research — understand market size, regional dynamics, and competitive structure for any industry in minutes
  • Deal sourcing context — use the Select Transactions section to identify active fundraising companies and leading investors in a sector
  • Competitive intelligence — track innovation trends and strategic partnerships across a sector to identify white spaces and disruption vectors
  • Custom report augmentation — supply custom_files to layer proprietary internal research or market data on top of Wokelo’s synthesis
This API is asynchronous. The initial POST returns a report_id only — not the report content. Report generation typically completes in 2–5 minutes. See How Async APIs work for a full explanation of the polling lifecycle.

2. Quick Start

Step 1 — Submit the report request
Step 2 — Poll for completion
Step 3 — Download the report

3. Authentication

All requests must include a Bearer token in the Authorization HTTP header.
API tokens are issued from your Wokelo account. Navigate to Account Details → API Credentials in the Wokelo dashboard to get your client id and client secret. Contact support@wokelo.ai if you do not yet have API access.
Never expose your token in client-side code, browser requests, or public repositories. A missing or invalid token returns 401 Unauthorized. A valid token without sufficient plan permissions returns 403 Forbidden.

4. Request Reference

Endpoint
All parameters are passed as JSON in the request body.
Unlike Company Research, Industry Research has no permalink, website, or workbook_name parameters. The industry string is the only identifier and the primary driver of report scope and quality.
Full request example:

5. Response

Submission response

The initial POST returns immediately with a single field:

Report status response

Poll GET /api/assets/get_notebook_status/?report_id={report_id} until the status field is "Completed".

Downloaded report structure

When you call Download Report with "file_type": "json", the response is a deeply nested JSON object. Each top-level key is a named report section. The five sections produced by Industry Research are: Executive Summary Contains two sub-keys:
  • Executive Summarysummary object with a source array of citation objects (id, title, url, publisher, date) and a summary field containing a full markdown-formatted multi-section narrative (Overview, Market Dynamics and Growth Drivers, Regional Market Leadership, Technological Innovation, Supply Chain, Regulatory Environment)
  • Key Insightskey_insights array of 8–10 insight card objects. Each card has:
    • insight — object with title (bold headline with key metric), paragraph (supporting data sentence), and sources array
    • commentary — array of 2–3 commentary paragraph objects, each with paragraph (analyst interpretation) and sources array
Overview Contains an industry_overview_details object with a source array and a summary field covering: industry definition, how it operates, key offerings (as named and described categories), market segments, and problems being solved. Trends and Innovations Contains a trend_and_innovations object with a source array and a summary field — a long-form markdown narrative organised by innovation themes (e.g. Advanced Materials, Cybersecurity, Printed Electronics, AI Automation, Predictive Maintenance, Sustainability, Adaptive Manufacturing, Strategic Partnerships). Select Transactions Contains two sub-keys:
  • Fundraising activitiesfundraising object with:
    • fundraising array — individual deal records (see below)
    • key_investors_in_this_spacekey_investors_in_this_space array — ranked investor records with organization (name, logo, url, permalink), no_of_investments, and key_investments (array of strings)
    • sources array — data attribution (typically Crunchbase)
    • charts object — three chart data structures (see below)
Fundraising deal record fields: Chart data structures: The charts object contains three keys, each with a title, data array, source attribution string, and url (pre-rendered chart image):
  • fundraising_line_chart — quarterly deal count time series. Each data point: {quarter: "Q3 '24", deals: 13}
  • fundraising_stage_chart — quarterly deal count broken out by stage (Seed Stage, Early Stage, Late Stage, Private Equity, Others). Each data point: {quarter: "Q3 '24", stage: "Early Stage", deals: 3}
  • fundraising_quarter_wise_chart — quarterly total funding raised. Each data point uses a two-field value structure: {quarter: "Q2 '24", funding: {value: 5.4, multiplier: 1000000000}} — multiply value × multiplier to get the raw USD amount
The fundraising_quarter_wise_chart uses a {value, multiplier} pattern rather than raw integers to keep chart data readable. Always multiply value × multiplier before presenting amounts: 5.4 × 1,000,000,000 = $5.4B. The multiplier is typically 1000000 (millions) or 1000000000 (billions), but always check rather than assuming.

Download format options


6. Examples

Basic industry research

Submit, poll, and download JSON — the standard three-step pattern.
Sample submission response:

Extracting key sections from the JSON report

Work with individual sections for targeted downstream processing.

Parsing fundraising chart data

The quarterly funding chart uses a {value, multiplier} two-field pattern. Parse it correctly before presenting amounts.

Identifying top investors in a sector

Use the key investors sub-section to find the most active investors for deal sourcing or LP targeting.

Batch research across a portfolio of sectors

Submit Industry Research for multiple sectors concurrently, then collect all reports.

Research with a custom file

Upload a proprietary report and attach it so Wokelo synthesises it alongside its own research.

Exporting as PPT for an IC presentation


7. Error Handling

The API uses standard HTTP status codes. The submission endpoint returns errors synchronously; processing errors appear as "Failed" status when polling. Handling a "Failed" report status:
Retry with exponential back-off on submission:

8. Best Practices

Be specific and descriptive in the industry string — this is the single highest-impact parameter The industry field is a free-text string, and the specificity of what you write directly determines how focused and useful the report is. Vague inputs like "technology" or "manufacturing" produce broad, shallow reports. Specific, descriptive inputs produce deep, actionable sector coverage:
workflow must always be "industry_primer" — not "company_primer" The /api/workflow_manager/start/ endpoint is shared across all Workflow APIs. The workflow parameter is what distinguishes Industry Research from Company Research, Peer Comparison, and Custom Workflow. For Industry Research, it must be exactly "industry_primer". Omitting it, misspelling it, or using "company_primer" returns a 400 error or generates the wrong report type. Store report_id immediately and durably The submission response contains only report_id. If this value is lost before the report is downloaded, there is no API endpoint to list or recover past report_id values. Store it to a database, log, or job queue entry as soon as the submission response is received:
Use 15–20 second polling intervals — not tight loops Industry Research reports typically complete in 2–5 minutes. Polling more frequently than every 15 seconds wastes rate limit budget without meaningfully reducing wait time. Use a progressive back-off for batch workloads:
Parse the {value, multiplier} chart pattern defensively The quarterly funding chart uses a two-field encoding (value × multiplier) rather than raw integers. Always compute the actual amount rather than presenting value directly — a label of "5.4" instead of "$5.4B" will confuse stakeholders:
Check for absent lead_investors / investors before accessing them Both fields are optional in fundraising deal records — they are omitted entirely (not set to []) when investor information was not publicly disclosed. Always use .get() with a default:
Use custom_files to incorporate proprietary research The custom_files parameter causes Wokelo to synthesise your uploaded documents alongside its web research, producing a report that bridges your internal knowledge with current market data. This is particularly valuable for sectors where you already hold proprietary market maps, prior diligence, or analyst reports. Upload files via the File Upload API first, then pass the returned fileName values in the array. Use "json" for pipelines; "ppt" or "pdf" for human deliverables The JSON output contains all structured data, citation arrays, and chart data. Use it for any programmatic downstream work. The formatted outputs strip much of the metadata but are better suited for IC decks, LP updates, and conference briefings. A single report_id supports all four formats — you can download both JSON and PPT for the same report without resubmitting. Understand the difference from Industry News Monitoring Industry Research and Industry News Monitoring both accept a free-text topic and both cover a sector — but they are fundamentally different in output and use case. Industry News Monitoring returns a paginated list of real-time news articles (synchronous, no report generation). Industry Research returns a synthesised, structured intelligence report with market sizing, trend analysis, and transaction data (asynchronous, minutes to generate). Use Industry News Monitoring for ongoing real-time tracking; use Industry Research for periodic deep-dive primers and one-time sector coverage.

Company Research

The company-level equivalent — generates a sourced intelligence report on any specific company using the same async workflow pattern.

Peer Comparison

Generate a structured side-by-side comparison of two or more companies across key dimensions in a single report.

Industry Deep Intelligence

Synchronous alternative for structured industry intelligence — returns results directly without the report polling step.

Industry News Monitoring

Real-time news articles for any industry topic — synchronous, paginated, no polling required. Complements Industry Research for ongoing monitoring.

Newsfeed

Structured multi-industry news feed filtered by sentiment, geography, and event category — ideal for recurring monitoring pipelines.

Supporting APIs

Report Status, Download Report, and File Upload — all used alongside Industry Research in the async workflow.

1. Overview

The Industry Research API generates an end-to-end sector intelligence report on any industry or market, covering market sizing, growth drivers, competitive dynamics, innovation trends, and recent transaction activity. The report is fully source-cited and delivered as structured JSON or as a formatted document (PDF, DOCX, or PPT). This is an asynchronous POST API — submitting a request returns a report_id immediately. You then poll for completion using the Report Status endpoint and retrieve the finished report using the Download Report endpoint. The three-step workflow:
The completed report is structured into five major sections, each returned as a named key in the JSON output:
  • Executive Summary — multi-paragraph narrative covering market size, growth drivers, regional dynamics, technology trends, supply chain, and regulatory landscape; fully source-cited with 20–30+ references
  • Key Insights — 8–10 analyst-style insight cards, each with a headline metric, supporting data paragraph, and multi-point commentary with citations
  • Overview — structured description of the industry — definition, key offerings, market segments, and core problems the sector solves
  • Trends and Innovations — detailed synthesis of technological, operational, and strategic trends reshaping the industry, with named company examples and quantified data points
  • Select Transactions — fundraising activity data for companies in the space, including per-deal records with investor details, funding stage, and amounts; quarterly deal-count and total-funding charts; and a ranked list of key investors
Common use cases:
  • Thesis development for new sectors — generate a sourced, structured primer on any industry before committing diligence resources to it
  • LP and IC briefing decks — export as PPT or PDF for sector updates, investment committee presentations, or fund strategy reviews
  • Market entry and expansion research — understand market size, regional dynamics, and competitive structure for any industry in minutes
  • Deal sourcing context — use the Select Transactions section to identify active fundraising companies and leading investors in a sector
  • Competitive intelligence — track innovation trends and strategic partnerships across a sector to identify white spaces and disruption vectors
  • Custom report augmentation — supply custom_files to layer proprietary internal research or market data on top of Wokelo’s synthesis
This API is asynchronous. The initial POST returns a report_id only — not the report content. Report generation typically completes in 2–5 minutes. See How Async APIs work for a full explanation of the polling lifecycle.

2. Quick Start

Step 1 — Submit the report request
Step 2 — Poll for completion
Step 3 — Download the report

3. Authentication

All requests must include a Bearer token in the Authorization HTTP header.
API tokens are issued from your Wokelo account. Navigate to Settings → API Keys in the Wokelo dashboard to generate or rotate a key. Contact support@wokelo.ai if you do not yet have API access.
Never expose your token in client-side code, browser requests, or public repositories. A missing or invalid token returns 401 Unauthorized. A valid token without sufficient plan permissions returns 403 Forbidden.

4. Request Reference

Endpoint
All parameters are passed as JSON in the request body.
Unlike Company Research, Industry Research has no permalink, website, or workbook_name parameters. The industry string is the only identifier and the primary driver of report scope and quality.
Full request example:

5. Response

Submission response

The initial POST returns immediately with a single field:

Report status response

Poll GET /api/assets/get_notebook_status/?report_id={report_id} until the status field is "Completed".

Downloaded report structure

When you call Download Report with "file_type": "json", the response is a deeply nested JSON object. Each top-level key is a named report section. The five sections produced by Industry Research are: Executive Summary Contains two sub-keys:
  • Executive Summarysummary object with a source array of citation objects (id, title, url, publisher, date) and a summary field containing a full markdown-formatted multi-section narrative (Overview, Market Dynamics and Growth Drivers, Regional Market Leadership, Technological Innovation, Supply Chain, Regulatory Environment)
  • Key Insightskey_insights array of 8–10 insight card objects. Each card has:
    • insight — object with title (bold headline with key metric), paragraph (supporting data sentence), and sources array
    • commentary — array of 2–3 commentary paragraph objects, each with paragraph (analyst interpretation) and sources array
Overview Contains an industry_overview_details object with a source array and a summary field covering: industry definition, how it operates, key offerings (as named and described categories), market segments, and problems being solved. Trends and Innovations Contains a trend_and_innovations object with a source array and a summary field — a long-form markdown narrative organised by innovation themes (e.g. Advanced Materials, Cybersecurity, Printed Electronics, AI Automation, Predictive Maintenance, Sustainability, Adaptive Manufacturing, Strategic Partnerships). Select Transactions Contains two sub-keys:
  • Fundraising activitiesfundraising object with:
    • fundraising array — individual deal records (see below)
    • key_investors_in_this_spacekey_investors_in_this_space array — ranked investor records with organization (name, logo, url, permalink), no_of_investments, and key_investments (array of strings)
    • sources array — data attribution (typically Crunchbase)
    • charts object — three chart data structures (see below)
Fundraising deal record fields: Chart data structures: The charts object contains three keys, each with a title, data array, source attribution string, and url (pre-rendered chart image):
  • fundraising_line_chart — quarterly deal count time series. Each data point: {quarter: "Q3 '24", deals: 13}
  • fundraising_stage_chart — quarterly deal count broken out by stage (Seed Stage, Early Stage, Late Stage, Private Equity, Others). Each data point: {quarter: "Q3 '24", stage: "Early Stage", deals: 3}
  • fundraising_quarter_wise_chart — quarterly total funding raised. Each data point uses a two-field value structure: {quarter: "Q2 '24", funding: {value: 5.4, multiplier: 1000000000}} — multiply value × multiplier to get the raw USD amount
The fundraising_quarter_wise_chart uses a {value, multiplier} pattern rather than raw integers to keep chart data readable. Always multiply value × multiplier before presenting amounts: 5.4 × 1,000,000,000 = $5.4B. The multiplier is typically 1000000 (millions) or 1000000000 (billions), but always check rather than assuming.

Download format options


6. Examples

Basic industry research

Submit, poll, and download JSON — the standard three-step pattern.
Sample submission response:

Extracting key sections from the JSON report

Work with individual sections for targeted downstream processing.

Parsing fundraising chart data

The quarterly funding chart uses a {value, multiplier} two-field pattern. Parse it correctly before presenting amounts.

Identifying top investors in a sector

Use the key investors sub-section to find the most active investors for deal sourcing or LP targeting.

Batch research across a portfolio of sectors

Submit Industry Research for multiple sectors concurrently, then collect all reports.

Research with a custom file

Upload a proprietary report and attach it so Wokelo synthesises it alongside its own research.

Exporting as PPT for an IC presentation


7. Error Handling

The API uses standard HTTP status codes. The submission endpoint returns errors synchronously; processing errors appear as "Failed" status when polling. Handling a "Failed" report status:
Retry with exponential back-off on submission:

8. Best Practices

Be specific and descriptive in the industry string — this is the single highest-impact parameter The industry field is a free-text string, and the specificity of what you write directly determines how focused and useful the report is. Vague inputs like "technology" or "manufacturing" produce broad, shallow reports. Specific, descriptive inputs produce deep, actionable sector coverage:
workflow must always be "industry_primer" — not "company_primer" The /api/workflow_manager/start/ endpoint is shared across all Workflow APIs. The workflow parameter is what distinguishes Industry Research from Company Research, Peer Comparison, and Custom Workflow. For Industry Research, it must be exactly "industry_primer". Omitting it, misspelling it, or using "company_primer" returns a 400 error or generates the wrong report type. Store report_id immediately and durably The submission response contains only report_id. If this value is lost before the report is downloaded, there is no API endpoint to list or recover past report_id values. Store it to a database, log, or job queue entry as soon as the submission response is received:
Use 15–20 second polling intervals — not tight loops Industry Research reports typically complete in 2–5 minutes. Polling more frequently than every 15 seconds wastes rate limit budget without meaningfully reducing wait time. Use a progressive back-off for batch workloads:
Parse the {value, multiplier} chart pattern defensively The quarterly funding chart uses a two-field encoding (value × multiplier) rather than raw integers. Always compute the actual amount rather than presenting value directly — a label of "5.4" instead of "$5.4B" will confuse stakeholders:
Check for absent lead_investors / investors before accessing them Both fields are optional in fundraising deal records — they are omitted entirely (not set to []) when investor information was not publicly disclosed. Always use .get() with a default:
Use custom_files to incorporate proprietary research The custom_files parameter causes Wokelo to synthesise your uploaded documents alongside its web research, producing a report that bridges your internal knowledge with current market data. This is particularly valuable for sectors where you already hold proprietary market maps, prior diligence, or analyst reports. Upload files via the File Upload API first, then pass the returned fileName values in the array. Use "json" for pipelines; "ppt" or "pdf" for human deliverables The JSON output contains all structured data, citation arrays, and chart data. Use it for any programmatic downstream work. The formatted outputs strip much of the metadata but are better suited for IC decks, LP updates, and conference briefings. A single report_id supports all four formats — you can download both JSON and PPT for the same report without resubmitting. Understand the difference from Industry News Monitoring Industry Research and Industry News Monitoring both accept a free-text topic and both cover a sector — but they are fundamentally different in output and use case. Industry News Monitoring returns a paginated list of real-time news articles (synchronous, no report generation). Industry Research returns a synthesised, structured intelligence report with market sizing, trend analysis, and transaction data (asynchronous, minutes to generate). Use Industry News Monitoring for ongoing real-time tracking; use Industry Research for periodic deep-dive primers and one-time sector coverage.

Company Research

The company-level equivalent — generates a sourced intelligence report on any specific company using the same async workflow pattern.

Peer Comparison

Generate a structured side-by-side comparison of two or more companies across key dimensions in a single report.

Industry Deep Intelligence

Synchronous alternative for structured industry intelligence — returns results directly without the report polling step.

Industry News Monitoring

Real-time news articles for any industry topic — synchronous, paginated, no polling required. Complements Industry Research for ongoing monitoring.

Newsfeed

Structured multi-industry news feed filtered by sentiment, geography, and event category — ideal for recurring monitoring pipelines.

Supporting APIs

Report Status, Download Report, and File Upload — all used alongside Industry Research in the async workflow.

1. Overview

The Industry Research API generates an end-to-end sector intelligence report on any industry or market, covering market sizing, growth drivers, competitive dynamics, innovation trends, and recent transaction activity. The report is fully source-cited and delivered as structured JSON or as a formatted document (PDF, DOCX, or PPT). This is an asynchronous POST API — submitting a request returns a report_id immediately. You then poll for completion using the Report Status endpoint and retrieve the finished report using the Download Report endpoint. The three-step workflow:
The completed report is structured into five major sections, each returned as a named key in the JSON output:
  • Executive Summary — multi-paragraph narrative covering market size, growth drivers, regional dynamics, technology trends, supply chain, and regulatory landscape; fully source-cited with 20–30+ references
  • Key Insights — 8–10 analyst-style insight cards, each with a headline metric, supporting data paragraph, and multi-point commentary with citations
  • Overview — structured description of the industry — definition, key offerings, market segments, and core problems the sector solves
  • Trends and Innovations — detailed synthesis of technological, operational, and strategic trends reshaping the industry, with named company examples and quantified data points
  • Select Transactions — fundraising activity data for companies in the space, including per-deal records with investor details, funding stage, and amounts; quarterly deal-count and total-funding charts; and a ranked list of key investors
Common use cases:
  • Thesis development for new sectors — generate a sourced, structured primer on any industry before committing diligence resources to it
  • LP and IC briefing decks — export as PPT or PDF for sector updates, investment committee presentations, or fund strategy reviews
  • Market entry and expansion research — understand market size, regional dynamics, and competitive structure for any industry in minutes
  • Deal sourcing context — use the Select Transactions section to identify active fundraising companies and leading investors in a sector
  • Competitive intelligence — track innovation trends and strategic partnerships across a sector to identify white spaces and disruption vectors
  • Custom report augmentation — supply custom_files to layer proprietary internal research or market data on top of Wokelo’s synthesis
This API is asynchronous. The initial POST returns a report_id only — not the report content. Report generation typically completes in 2–5 minutes. See How Async APIs work for a full explanation of the polling lifecycle.

2. Quick Start

Step 1 — Submit the report request
Step 2 — Poll for completion
Step 3 — Download the report

3. Authentication

All requests must include a Bearer token in the Authorization HTTP header.
API tokens are issued from your Wokelo account. Navigate to Settings → API Keys in the Wokelo dashboard to generate or rotate a key. Contact support@wokelo.ai if you do not yet have API access.
Never expose your token in client-side code, browser requests, or public repositories. A missing or invalid token returns 401 Unauthorized. A valid token without sufficient plan permissions returns 403 Forbidden.

4. Request Reference

Endpoint
All parameters are passed as JSON in the request body.
Unlike Company Research, Industry Research has no permalink, website, or workbook_name parameters. The industry string is the only identifier and the primary driver of report scope and quality.
Full request example:

5. Response

Submission response

The initial POST returns immediately with a single field:

Report status response

Poll GET /api/assets/get_notebook_status/?report_id={report_id} until the status field is "Completed".

Downloaded report structure

When you call Download Report with "file_type": "json", the response is a deeply nested JSON object. Each top-level key is a named report section. The five sections produced by Industry Research are: Executive Summary Contains two sub-keys:
  • Executive Summarysummary object with a source array of citation objects (id, title, url, publisher, date) and a summary field containing a full markdown-formatted multi-section narrative (Overview, Market Dynamics and Growth Drivers, Regional Market Leadership, Technological Innovation, Supply Chain, Regulatory Environment)
  • Key Insightskey_insights array of 8–10 insight card objects. Each card has:
    • insight — object with title (bold headline with key metric), paragraph (supporting data sentence), and sources array
    • commentary — array of 2–3 commentary paragraph objects, each with paragraph (analyst interpretation) and sources array
Overview Contains an industry_overview_details object with a source array and a summary field covering: industry definition, how it operates, key offerings (as named and described categories), market segments, and problems being solved. Trends and Innovations Contains a trend_and_innovations object with a source array and a summary field — a long-form markdown narrative organised by innovation themes (e.g. Advanced Materials, Cybersecurity, Printed Electronics, AI Automation, Predictive Maintenance, Sustainability, Adaptive Manufacturing, Strategic Partnerships). Select Transactions Contains two sub-keys:
  • Fundraising activitiesfundraising object with:
    • fundraising array — individual deal records (see below)
    • key_investors_in_this_spacekey_investors_in_this_space array — ranked investor records with organization (name, logo, url, permalink), no_of_investments, and key_investments (array of strings)
    • sources array — data attribution (typically Crunchbase)
    • charts object — three chart data structures (see below)
Fundraising deal record fields: Chart data structures: The charts object contains three keys, each with a title, data array, source attribution string, and url (pre-rendered chart image):
  • fundraising_line_chart — quarterly deal count time series. Each data point: {quarter: "Q3 '24", deals: 13}
  • fundraising_stage_chart — quarterly deal count broken out by stage (Seed Stage, Early Stage, Late Stage, Private Equity, Others). Each data point: {quarter: "Q3 '24", stage: "Early Stage", deals: 3}
  • fundraising_quarter_wise_chart — quarterly total funding raised. Each data point uses a two-field value structure: {quarter: "Q2 '24", funding: {value: 5.4, multiplier: 1000000000}} — multiply value × multiplier to get the raw USD amount
The fundraising_quarter_wise_chart uses a {value, multiplier} pattern rather than raw integers to keep chart data readable. Always multiply value × multiplier before presenting amounts: 5.4 × 1,000,000,000 = $5.4B. The multiplier is typically 1000000 (millions) or 1000000000 (billions), but always check rather than assuming.

Download format options


6. Examples

Basic industry research

Submit, poll, and download JSON — the standard three-step pattern.
Sample submission response:

Extracting key sections from the JSON report

Work with individual sections for targeted downstream processing.

Parsing fundraising chart data

The quarterly funding chart uses a {value, multiplier} two-field pattern. Parse it correctly before presenting amounts.

Identifying top investors in a sector

Use the key investors sub-section to find the most active investors for deal sourcing or LP targeting.

Batch research across a portfolio of sectors

Submit Industry Research for multiple sectors concurrently, then collect all reports.

Research with a custom file

Upload a proprietary report and attach it so Wokelo synthesises it alongside its own research.

Exporting as PPT for an IC presentation


7. Error Handling

The API uses standard HTTP status codes. The submission endpoint returns errors synchronously; processing errors appear as "Failed" status when polling. Handling a "Failed" report status:
Retry with exponential back-off on submission:

8. Best Practices

Be specific and descriptive in the industry string — this is the single highest-impact parameter The industry field is a free-text string, and the specificity of what you write directly determines how focused and useful the report is. Vague inputs like "technology" or "manufacturing" produce broad, shallow reports. Specific, descriptive inputs produce deep, actionable sector coverage:
workflow must always be "industry_primer" — not "company_primer" The /api/workflow_manager/start/ endpoint is shared across all Workflow APIs. The workflow parameter is what distinguishes Industry Research from Company Research, Peer Comparison, and Custom Workflow. For Industry Research, it must be exactly "industry_primer". Omitting it, misspelling it, or using "company_primer" returns a 400 error or generates the wrong report type. Store report_id immediately and durably The submission response contains only report_id. If this value is lost before the report is downloaded, there is no API endpoint to list or recover past report_id values. Store it to a database, log, or job queue entry as soon as the submission response is received:
Use 15–20 second polling intervals — not tight loops Industry Research reports typically complete in 2–5 minutes. Polling more frequently than every 15 seconds wastes rate limit budget without meaningfully reducing wait time. Use a progressive back-off for batch workloads:
Parse the {value, multiplier} chart pattern defensively The quarterly funding chart uses a two-field encoding (value × multiplier) rather than raw integers. Always compute the actual amount rather than presenting value directly — a label of "5.4" instead of "$5.4B" will confuse stakeholders:
Check for absent lead_investors / investors before accessing them Both fields are optional in fundraising deal records — they are omitted entirely (not set to []) when investor information was not publicly disclosed. Always use .get() with a default:
Use custom_files to incorporate proprietary research The custom_files parameter causes Wokelo to synthesise your uploaded documents alongside its web research, producing a report that bridges your internal knowledge with current market data. This is particularly valuable for sectors where you already hold proprietary market maps, prior diligence, or analyst reports. Upload files via the File Upload API first, then pass the returned fileName values in the array. Use "json" for pipelines; "ppt" or "pdf" for human deliverables The JSON output contains all structured data, citation arrays, and chart data. Use it for any programmatic downstream work. The formatted outputs strip much of the metadata but are better suited for IC decks, LP updates, and conference briefings. A single report_id supports all four formats — you can download both JSON and PPT for the same report without resubmitting. Understand the difference from Industry News Monitoring Industry Research and Industry News Monitoring both accept a free-text topic and both cover a sector — but they are fundamentally different in output and use case. Industry News Monitoring returns a paginated list of real-time news articles (synchronous, no report generation). Industry Research returns a synthesised, structured intelligence report with market sizing, trend analysis, and transaction data (asynchronous, minutes to generate). Use Industry News Monitoring for ongoing real-time tracking; use Industry Research for periodic deep-dive primers and one-time sector coverage.

Company Research

The company-level equivalent — generates a sourced intelligence report on any specific company using the same async workflow pattern.

Peer Comparison

Generate a structured side-by-side comparison of two or more companies across key dimensions in a single report.

Industry Deep Intelligence

Synchronous alternative for structured industry intelligence — returns results directly without the report polling step.

Industry News Monitoring

Real-time news articles for any industry topic — synchronous, paginated, no polling required. Complements Industry Research for ongoing monitoring.

Newsfeed

Structured multi-industry news feed filtered by sentiment, geography, and event category — ideal for recurring monitoring pipelines.

Supporting APIs

Report Status, Download Report, and File Upload — all used alongside Industry Research in the async workflow.