> ## 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.
# Industry Deep Intelligence
> Generates structured insights for a given industry or sector. Returns a `request_id` for async polling.
## Overview
The Industry Insights API generates structured insights for a given industry topic (e.g., *"Warehouse automation"*). Optionally, you can refine the output by specifying sections, keywords, geography, a custom industry definition, and sample companies. Returns a `request_id` as a response.
## Endpoint Details
* **Method:** POST
* **Endpoint:** `/api/enterprise/industry/enrich/`
## Authentication Requirements
* Include a valid JWT token in your request header
* If you don't have a token yet, you can get one from the `/auth/token/` endpoint first.
## Request
#### Header Parameters
JWT token obtained from the Authentication request
#### Body Parameters
The industry topic to generate insights for (e.g. `"Enterprise SaaS security"`)
Sections to include in the report. Select one or more values.
Supported values: `market_size`, `quant_insights`, `trends_and_innovations`, `transactions_mna`, `transactions_fundraising`, `transactions_ipo`, `partnerships`, `tier1_intelligence`, `case_studies`, `industry_regulations`
Optional filter parameters. All fields inside are optional.
Keywords to focus the analysis on (e.g. `"zero trust"`, `"SIEM"`)
Geographic scope as ISO country codes (e.g. `["USA", "GBR"]`)
A custom definition of the industry to guide report generation
Permalinks of representative companies in the industry
### Response
A successful response returns a `request_id` that can be used to track the status of the request.
#### Successful Response Fields
Unique identifier for the request posted. Use this with the `/api/enterprise/request/status/` endpoint to check the status
Status of the request (e.g. `"PENDING"`)
```json 202 theme={"system"}
{
"request_id": "c574254f-137d-40d5-84f1-ac8fa38b8aa7",
"status": "PENDING"
}
```
## OpenAPI
````yaml POST /api/enterprise/industry/enrich/
openapi: 3.0.3
info:
title: Wokelo API
description: >
Wokelo provides four categories of APIs for company and market intelligence:
1. **Enrichment** – Company and Industry data using Wokelo database and
alternative data. Supports multi-company requests.
2. **Discovery** – Workflows for specific use-cases such as market map,
target screening, and buyer screening.
3. **Monitoring** – Real-time news monitoring for companies.
4. **Workflow Automation** – Wokelo and custom research workflows executed
within notebooks.
Enrichment and Discovery APIs are managed through async requests; use the
Supporting APIs to track status and export results in JSON.
Workflow APIs are executed within notebooks and support export to PDF, PPT,
DOC, or JSON.
**Authentication:** All endpoints (except `/auth/token/`) require a Bearer
JWT token in the `Authorization` header.
version: 1.0.0
contact:
url: https://docs.wokelo.ai/contact
servers:
- url: https://api.wokelo.ai
description: Production server
security: []
tags:
- name: Authentication
description: Obtain JWT tokens for API access
- name: Enrichment
description: Retrieve structured data for companies and industries
- name: Discovery
description: Identify companies via market maps, buyer and target screening
- name: Monitoring
description: Real-time company news monitoring
- name: Workflow Automation
description: Research notebooks for companies, industries, and custom workflows
- name: Supporting APIs
description: >-
Utility endpoints for search, file upload, request management, and report
retrieval
externalDocs:
description: Official Wokelo API Documentation
url: https://docs.wokelo.ai/overview
paths:
/api/enterprise/industry/enrich/:
post:
tags:
- Enrichment
summary: Industry Deep Intelligence
description: >-
Generates structured insights for a given industry or sector. Returns a
`request_id` for async polling.
operationId: industryDeepIntelligence
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- topic
properties:
topic:
type: string
description: The industry topic to generate insights for.
example: Enterprise SaaS security
sections:
type: array
description: >-
Sections to include in the report. Select one or more
values.
uniqueItems: true
items:
type: string
enum:
- market_size
- quant_insights
- trends_and_innovations
- transactions_mna
- transactions_fundraising
- transactions_ipo
- partnerships
- tier1_intelligence
- case_studies
- industry_regulations
example:
- market_size
- trends_and_innovations
- transactions_mna
parameters:
type: object
description: Optional filter parameters.
properties:
keywords:
type: array
description: Keywords to focus the analysis on.
items:
type: string
example:
- zero trust
- SIEM
geography:
type: array
description: Geographic scope as ISO country codes.
items:
type: string
example:
- USA
definition:
type: string
description: >-
A custom definition of the industry to guide report
generation.
example: B2B software focused on enterprise cybersecurity
sample_companies:
type: array
description: Permalinks of representative companies in the industry.
items:
type: string
example:
- crowdstrike
- sentinel
example:
industry: Enterprise SaaS security
sections:
- market_size
- trends_and_innovations
- transactions_mna
parameters:
keywords:
- zero trust
- SIEM
geography:
- USA
definition: B2B software focused on enterprise cybersecurity
sample_companies:
- crowdstrike
- sentinel
responses:
'202':
description: Request accepted
content:
application/json:
schema:
$ref: '#/components/schemas/AsyncResponse'
security:
- bearerAuth: []
components:
schemas:
AsyncResponse:
type: object
properties:
request_id:
type: string
format: uuid
example: 931643e9-b6c7-45d4-9ba9-bd3b534221e7
status:
type: string
enum:
- PENDING
- PROCESSING
- COMPLETED
- FAILED
example: PENDING
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: JWT token obtained from the `/auth/token/` endpoint.
````