Documentation Index
Fetch the complete documentation index at: https://docs.wokelo.ai/llms.txt
Use this file to discover all available pages before exploring further.
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 areport_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:
- 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
- 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_filesto 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 request3. Authentication
All requests must include a Bearer token in theAuthorization HTTP header.
4. Request Reference
Endpoint| Parameter | Type | Required | Description |
|---|---|---|---|
workflow | string | Required | Must always be "industry_primer". This fixed value tells Wokelo’s workflow engine to run the Industry Research report. Do not confuse with "company_primer" (Company Research) or "peer_comparison" (Peer Comparison). |
industry | string | Required | Free-text description of the industry or sector to research. Specificity drives report quality — see Best Practices for guidance on phrasing. Examples: "Warehouse Automation", "Electronics Manufacturing Services", "GLP-1 Obesity Drug Market", "Offshore Wind Energy". |
custom_files | object[] | Optional | Array of file references to include in the report alongside Wokelo’s synthesis. Each object should use the fileName value returned by the File Upload API. Use this to incorporate proprietary market research, analyst reports, or internal sector notes. |
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.5. Response
Submission response
The initial POST returns immediately with a single field:| Field | Type | Description |
|---|---|---|
report_id | integer | Unique identifier for this report job. Use it with the Report Status and Download Report endpoints to track and retrieve the completed report. Store this value immediately — it is the only handle to your report. |
Report status response
PollGET /api/assets/get_notebook_status/?report_id={report_id} until the status field is "Completed".
| Status value | Meaning |
|---|---|
"Pending" | Report is queued and waiting to start. |
"Processing" | Report generation is in progress. |
"Completed" | Report is ready to download. |
"Failed" | Report generation encountered an error. Retry the submission. |
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 Summary→summaryobject with asourcearray of citation objects (id,title,url,publisher,date) and asummaryfield containing a full markdown-formatted multi-section narrative (Overview, Market Dynamics and Growth Drivers, Regional Market Leadership, Technological Innovation, Supply Chain, Regulatory Environment)Key Insights→key_insightsarray of 8–10 insight card objects. Each card has:insight— object withtitle(bold headline with key metric),paragraph(supporting data sentence), andsourcesarraycommentary— array of 2–3 commentary paragraph objects, each withparagraph(analyst interpretation) andsourcesarray
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 activities→fundraisingobject with:fundraisingarray — individual deal records (see below)key_investors_in_this_space→key_investors_in_this_spacearray — ranked investor records withorganization(name, logo, url, permalink),no_of_investments, andkey_investments(array of strings)sourcesarray — data attribution (typically Crunchbase)chartsobject — three chart data structures (see below)
| Field | Type | Description |
|---|---|---|
organization | object | Company that raised. Contains name, url (Wokelo dashboard link), logo, and permalink. |
funding | integer | Raw USD amount raised (e.g. 30000000 for $30M). Always a numeric integer — never an empty string. |
funding_type | string | Round type. Examples: "Series A", "Series B", "Seed", "Debt-Funded", "Non-Equity Assistance", "Corporate-Funded", "Private Equity". |
date | string | Close date in DD-Mon-YYYY format (e.g. "23-Dec-2025"). |
product_category | string | Short label for the company’s product or service area. |
lead_investors | object[] | Array of lead investor objects, each with an organization sub-object (name, url, logo, permalink). May be absent when lead was not publicly disclosed. |
investors | object[] | Array of non-lead investor objects, same structure as lead_investors. May be absent. |
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}}— multiplyvalue × multiplierto 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
file_type | Description |
|---|---|
"json" | Fully structured JSON — all sections, fields, and source citations. Best for programmatic processing, pipeline ingestion, or downstream analysis. |
"pdf" | Formatted PDF report. Best for sharing with stakeholders who need a readable, printable document. |
"docx" | Editable Word document. Best for teams that customise or annotate reports before distribution. |
"ppt" | PowerPoint presentation with section slides. Best for IC presentations, LP updates, and conference briefings. |
6. Examples
Basic industry research
Submit, poll, and download JSON — the standard three-step pattern.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.
| Status | Meaning | Cause & Resolution |
|---|---|---|
200 OK | Request accepted | report_id returned. Proceed to polling. |
400 Bad Request | Invalid parameters | Missing workflow, missing industry, or unrecognised workflow string. Check the detail field. Ensure workflow is exactly "industry_primer". |
401 Unauthorized | Auth failed | The Authorization header is missing or contains an invalid token. Verify your key in Settings → API Keys. |
403 Forbidden | Insufficient access | Your plan does not include access to this endpoint. Contact support@wokelo.ai. |
429 Too Many Requests | Rate limit exceeded | Implement exponential back-off on submission. The response includes a Retry-After header. |
500 Internal Server Error | Server error | Retry the submission after a brief delay. If the issue persists, contact support@wokelo.ai. |
"Failed" report status:
8. Best Practices
Be specific and descriptive in theindustry 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:
{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:
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:
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.
9. Related APIs
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 areport_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:
- 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
- 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_filesto 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 request3. Authentication
All requests must include a Bearer token in theAuthorization HTTP header.
4. Request Reference
Endpoint| Parameter | Type | Required | Description |
|---|---|---|---|
workflow | string | Required | Must always be "industry_primer". This fixed value tells Wokelo’s workflow engine to run the Industry Research report. Do not confuse with "company_primer" (Company Research) or "peer_comparison" (Peer Comparison). |
industry | string | Required | Free-text description of the industry or sector to research. Specificity drives report quality — see Best Practices for guidance on phrasing. Examples: "Warehouse Automation", "Electronics Manufacturing Services", "GLP-1 Obesity Drug Market", "Offshore Wind Energy". |
custom_files | object[] | Optional | Array of file references to include in the report alongside Wokelo’s synthesis. Each object should use the fileName value returned by the File Upload API. Use this to incorporate proprietary market research, analyst reports, or internal sector notes. |
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.5. Response
Submission response
The initial POST returns immediately with a single field:| Field | Type | Description |
|---|---|---|
report_id | integer | Unique identifier for this report job. Use it with the Report Status and Download Report endpoints to track and retrieve the completed report. Store this value immediately — it is the only handle to your report. |
Report status response
PollGET /api/assets/get_notebook_status/?report_id={report_id} until the status field is "Completed".
| Status value | Meaning |
|---|---|
"Pending" | Report is queued and waiting to start. |
"Processing" | Report generation is in progress. |
"Completed" | Report is ready to download. |
"Failed" | Report generation encountered an error. Retry the submission. |
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 Summary→summaryobject with asourcearray of citation objects (id,title,url,publisher,date) and asummaryfield containing a full markdown-formatted multi-section narrative (Overview, Market Dynamics and Growth Drivers, Regional Market Leadership, Technological Innovation, Supply Chain, Regulatory Environment)Key Insights→key_insightsarray of 8–10 insight card objects. Each card has:insight— object withtitle(bold headline with key metric),paragraph(supporting data sentence), andsourcesarraycommentary— array of 2–3 commentary paragraph objects, each withparagraph(analyst interpretation) andsourcesarray
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 activities→fundraisingobject with:fundraisingarray — individual deal records (see below)key_investors_in_this_space→key_investors_in_this_spacearray — ranked investor records withorganization(name, logo, url, permalink),no_of_investments, andkey_investments(array of strings)sourcesarray — data attribution (typically Crunchbase)chartsobject — three chart data structures (see below)
| Field | Type | Description |
|---|---|---|
organization | object | Company that raised. Contains name, url (Wokelo dashboard link), logo, and permalink. |
funding | integer | Raw USD amount raised (e.g. 30000000 for $30M). Always a numeric integer — never an empty string. |
funding_type | string | Round type. Examples: "Series A", "Series B", "Seed", "Debt-Funded", "Non-Equity Assistance", "Corporate-Funded", "Private Equity". |
date | string | Close date in DD-Mon-YYYY format (e.g. "23-Dec-2025"). |
product_category | string | Short label for the company’s product or service area. |
lead_investors | object[] | Array of lead investor objects, each with an organization sub-object (name, url, logo, permalink). May be absent when lead was not publicly disclosed. |
investors | object[] | Array of non-lead investor objects, same structure as lead_investors. May be absent. |
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}}— multiplyvalue × multiplierto 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
file_type | Description |
|---|---|
"json" | Fully structured JSON — all sections, fields, and source citations. Best for programmatic processing, pipeline ingestion, or downstream analysis. |
"pdf" | Formatted PDF report. Best for sharing with stakeholders who need a readable, printable document. |
"docx" | Editable Word document. Best for teams that customise or annotate reports before distribution. |
"ppt" | PowerPoint presentation with section slides. Best for IC presentations, LP updates, and conference briefings. |
6. Examples
Basic industry research
Submit, poll, and download JSON — the standard three-step pattern.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.
| Status | Meaning | Cause & Resolution |
|---|---|---|
200 OK | Request accepted | report_id returned. Proceed to polling. |
400 Bad Request | Invalid parameters | Missing workflow, missing industry, or unrecognised workflow string. Check the detail field. Ensure workflow is exactly "industry_primer". |
401 Unauthorized | Auth failed | The Authorization header is missing or contains an invalid token. Verify your key in Settings → API Keys. |
403 Forbidden | Insufficient access | Your plan does not include access to this endpoint. Contact support@wokelo.ai. |
429 Too Many Requests | Rate limit exceeded | Implement exponential back-off on submission. The response includes a Retry-After header. |
500 Internal Server Error | Server error | Retry the submission after a brief delay. If the issue persists, contact support@wokelo.ai. |
"Failed" report status:
8. Best Practices
Be specific and descriptive in theindustry 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:
{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:
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:
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.
9. Related APIs
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 areport_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:
- 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
- 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_filesto 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 request3. Authentication
All requests must include a Bearer token in theAuthorization HTTP header.
4. Request Reference
Endpoint| Parameter | Type | Required | Description |
|---|---|---|---|
workflow | string | Required | Must always be "industry_primer". This fixed value tells Wokelo’s workflow engine to run the Industry Research report. Do not confuse with "company_primer" (Company Research) or "peer_comparison" (Peer Comparison). |
industry | string | Required | Free-text description of the industry or sector to research. Specificity drives report quality — see Best Practices for guidance on phrasing. Examples: "Warehouse Automation", "Electronics Manufacturing Services", "GLP-1 Obesity Drug Market", "Offshore Wind Energy". |
custom_files | object[] | Optional | Array of file references to include in the report alongside Wokelo’s synthesis. Each object should use the fileName value returned by the File Upload API. Use this to incorporate proprietary market research, analyst reports, or internal sector notes. |
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.5. Response
Submission response
The initial POST returns immediately with a single field:| Field | Type | Description |
|---|---|---|
report_id | integer | Unique identifier for this report job. Use it with the Report Status and Download Report endpoints to track and retrieve the completed report. Store this value immediately — it is the only handle to your report. |
Report status response
PollGET /api/assets/get_notebook_status/?report_id={report_id} until the status field is "Completed".
| Status value | Meaning |
|---|---|
"Pending" | Report is queued and waiting to start. |
"Processing" | Report generation is in progress. |
"Completed" | Report is ready to download. |
"Failed" | Report generation encountered an error. Retry the submission. |
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 Summary→summaryobject with asourcearray of citation objects (id,title,url,publisher,date) and asummaryfield containing a full markdown-formatted multi-section narrative (Overview, Market Dynamics and Growth Drivers, Regional Market Leadership, Technological Innovation, Supply Chain, Regulatory Environment)Key Insights→key_insightsarray of 8–10 insight card objects. Each card has:insight— object withtitle(bold headline with key metric),paragraph(supporting data sentence), andsourcesarraycommentary— array of 2–3 commentary paragraph objects, each withparagraph(analyst interpretation) andsourcesarray
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 activities→fundraisingobject with:fundraisingarray — individual deal records (see below)key_investors_in_this_space→key_investors_in_this_spacearray — ranked investor records withorganization(name, logo, url, permalink),no_of_investments, andkey_investments(array of strings)sourcesarray — data attribution (typically Crunchbase)chartsobject — three chart data structures (see below)
| Field | Type | Description |
|---|---|---|
organization | object | Company that raised. Contains name, url (Wokelo dashboard link), logo, and permalink. |
funding | integer | Raw USD amount raised (e.g. 30000000 for $30M). Always a numeric integer — never an empty string. |
funding_type | string | Round type. Examples: "Series A", "Series B", "Seed", "Debt-Funded", "Non-Equity Assistance", "Corporate-Funded", "Private Equity". |
date | string | Close date in DD-Mon-YYYY format (e.g. "23-Dec-2025"). |
product_category | string | Short label for the company’s product or service area. |
lead_investors | object[] | Array of lead investor objects, each with an organization sub-object (name, url, logo, permalink). May be absent when lead was not publicly disclosed. |
investors | object[] | Array of non-lead investor objects, same structure as lead_investors. May be absent. |
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}}— multiplyvalue × multiplierto 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
file_type | Description |
|---|---|
"json" | Fully structured JSON — all sections, fields, and source citations. Best for programmatic processing, pipeline ingestion, or downstream analysis. |
"pdf" | Formatted PDF report. Best for sharing with stakeholders who need a readable, printable document. |
"docx" | Editable Word document. Best for teams that customise or annotate reports before distribution. |
"ppt" | PowerPoint presentation with section slides. Best for IC presentations, LP updates, and conference briefings. |
6. Examples
Basic industry research
Submit, poll, and download JSON — the standard three-step pattern.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.
| Status | Meaning | Cause & Resolution |
|---|---|---|
200 OK | Request accepted | report_id returned. Proceed to polling. |
400 Bad Request | Invalid parameters | Missing workflow, missing industry, or unrecognised workflow string. Check the detail field. Ensure workflow is exactly "industry_primer". |
401 Unauthorized | Auth failed | The Authorization header is missing or contains an invalid token. Verify your key in Settings → API Keys. |
403 Forbidden | Insufficient access | Your plan does not include access to this endpoint. Contact support@wokelo.ai. |
429 Too Many Requests | Rate limit exceeded | Implement exponential back-off on submission. The response includes a Retry-After header. |
500 Internal Server Error | Server error | Retry the submission after a brief delay. If the issue persists, contact support@wokelo.ai. |
"Failed" report status:
8. Best Practices
Be specific and descriptive in theindustry 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:
{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:
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:
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.
9. Related APIs
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.