Skip to main content

1. Overview

The Industry Deep Intelligence API generates structured, source-cited intelligence on any industry or sector. Unlike the Industry Research Workflow (which always produces a fixed five-section report via an async job system), this API lets you select exactly which sections you need — requesting only market sizing, or only M&A activity, or any combination of the ten available section types — and returns results through a lightweight async polling loop. This is an asynchronous POST API — submitting a request returns a request_id (a UUID string) and an initial "PENDING" status immediately. You then poll the Request Status endpoint with that request_id until the status becomes "COMPLETED", at which point the full result is embedded directly in the status response. The two-step workflow:
This API uses a different async pattern from the Workflow APIs (Company Research, Industry Research, Peer Comparison, Custom Workflow). Those APIs use report_id (integer) with separate submission and download steps. This API uses request_id (UUID string) and embeds the completed result directly in the status polling response — no separate download call is needed.
The ten available sections: Common use cases:
  • Market entry sizing — request market_size + quant_insights for a new sector before committing diligence resources; get a multi-source CAGR range immediately
  • Deal sourcing intelligence — request transactions_mna + transactions_fundraising to surface active deal flow and recently funded companies in a space
  • IC memo background research — request tier1_intelligence + trends_and_innovations for a concise, credible sector context block with McKinsey/BCG sourcing
  • Regulatory risk assessment — request industry_regulations for a specific geography to map compliance requirements for a target sector
  • Competitive case study analysis — request case_studies to rapidly profile 3–4 key players in a market before a competitive diligence sprint
  • Modular pipeline enrichment — run specific sections on multiple sectors in parallel and stitch results into a unified research database
This API is asynchronous. Submit a request, then poll until status = "COMPLETED". See How Async APIs work for a full explanation of the polling lifecycle.

2. Quick Start

Step 1 — Submit a request
Step 2 — Poll until completed and retrieve the result
Step 3 — Work with the result

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. Supported sections: Full request example:

5. Response

Submission response

The initial POST returns a 202 Accepted with two fields:

Status polling response

Poll GET /api/enterprise/request/status/?request_id={request_id}. The status field progresses through the following values:

Completed result structure

When status is "COMPLETED", the polling response includes a result object. The result is structured as:
The top-level result key is always "IP enrichment". Your requested sections appear as child keys of this object, keyed by the section name you submitted.

meta object

Section-level response schemas

market_size
Each object in the data array represents one market research publisher’s estimate. Values use the {value, multiplier} pattern — always multiply before presenting. cagr is a string (not a float) representing percentage. trends_and_innovations
The summary field is a full markdown narrative with bold topic headings, named company examples, quantified data points, and inline source brackets referencing the source array by id. All other sections (quant_insights, transactions_mna, transactions_fundraising, transactions_ipo, partnerships, tier1_intelligence, case_studies, industry_regulations) follow the same general pattern as trends_and_innovations: a named sub-object containing a source array and a summary markdown string. Some sections may additionally include structured charts objects similar to market_size.
Market size start_value, end_value, and estimated_value all use the {value, multiplier} encoding — the same pattern as Industry Research fundraising charts. Always compute value × multiplier to get the raw USD amount: 2.5 × 1,000,000,000 = $2.5B. The cagr field is a string, not a float; parse with float(entry["cagr"]) before arithmetic.

6. Examples

Market sizing for a new sector

Request only market_size for a fast, focused market sizing check before committing broader diligence.
Sample submission response:

Deal flow intelligence — M&A and fundraising

Request both transaction sections to surface active deal flow and recently funded companies for a target sector.
Pull McKinsey/BCG-sourced insights and innovation trends for a sector in a single call for an IC memo background section.

Regulatory risk scan for a specific geography

Scope industry_regulations to a single country to assess jurisdiction-specific compliance requirements.

Full-section deep dive

Request all ten sections for a comprehensive sector intelligence run.

Batch analysis across multiple sectors

Run Industry Deep Intelligence on several sectors in parallel and collect all results.

JavaScript / Node.js


7. Error Handling

The API uses standard HTTP status codes. The submission endpoint returns a 202 on success and synchronous errors for invalid requests. Processing errors appear as "FAILED" status when polling. Handling a "FAILED" request status:
Retry with exponential back-off:

8. Best Practices

Request only the sections you need — each section adds processing time Unlike Workflow APIs that always generate a fixed full report, this API lets you select precisely the sections relevant to your use case. A single-section market_size request completes significantly faster than a full ten-section run. For tight turnaround use cases (IC prep, quick market checks), request one to three sections maximum:
Be specific in the topic string — it is the primary quality driver The topic field is free-text and specificity directly determines how focused the output is. Vague topics produce generic, shallow results:
Use parameters.definition to resolve ambiguity when the topic alone is insufficient When your topic string could be interpreted in multiple ways, the definition parameter anchors the analysis to your intended scope. This is particularly useful for topics that span consumer and enterprise, or that sit at the intersection of multiple industries:
request_id is a UUID string — it is not interchangeable with report_id This API returns a UUID request_id (e.g. "c574254f-137d-40d5-84f1-ac8fa38b8aa7"). The Workflow APIs return an integer report_id. These use different polling endpoints and cannot be mixed:
The result is embedded in the polling response — no separate download call Unlike the Workflow APIs (which require a separate POST /api/assets/download_report/ call after polling), this API embeds the full result in the status response when status == "COMPLETED". Extract data["result"] directly from the poll response:
Parse market_size chart values with the {value, multiplier} pattern Each market size data point stores values as {value, multiplier} pairs rather than raw numbers. Always multiply before presenting, and note that cagr is a string not a float:
Use parameters.sample_companies to ground the analysis in your competitive set Providing representative company permalinks in sample_companies guides the AI analysis toward the right competitive context, particularly for niche sectors where the topic string alone might be interpreted too broadly. Use permalinks (not website URLs) — find them via the Company Search API:
Understand how this differs from Industry Research (Workflow API) Industry Deep Intelligence and Industry Research both cover industry topics, but serve different needs. Industry Deep Intelligence offers section-level selectivity — request only what you need, get results in minutes through a lightweight polling loop. Industry Research always generates a fixed five-section report (Executive Summary, Key Insights, Overview, Trends, Select Transactions) through the Workflow API infrastructure and typically takes longer. Use Industry Deep Intelligence when you need specific sections quickly or want to compose your own multi-section pipeline; use Industry Research when you want a complete, formatted deliverable (PDF, DOCX, PPT) in one job.

Industry Research

The async Workflow alternative — generates a fixed five-section industry report with PDF/DOCX/PPT export. Use when you need a complete formatted deliverable.

Company Deep Intelligence

The company-level equivalent — section-selective deep intelligence on any specific company, using the same async request_id pattern.

Industry News Monitoring

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

Market Map

Discover and map all companies competing in a specific market or product category — ideal to run alongside Industry Deep Intelligence for a competitive landscape.

Newsfeed

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

Supporting APIs

Request Status and Company Search — both used alongside Industry Deep Intelligence in the async workflow.