> ## 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.
# Company Deep Intelligence
> Delivers / data for one or more companies. Returns a `request_id` for async polling.
## Overview
The Company Insights API delivers structured insights for one or more companies across sections such as products & services, product launches, strategic initiatives, partnerships, and more. Optionally, you can customize the output by specifying which sections to include and defining custom fields with your own prompts. Returns a `request_id` as a response.
## Endpoint Details
* **Method:** POST
* **Endpoint:** `/api/enterprise/company/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
List of permalinks or URLs of the companies to enrich (e.g. `"tesla-motors"`, `"stripe"` or `"https://tesla.com"`)
Sections of data to include in the output. Select one or more values.
Supported values: `products_and_services`, `product_launches`, `strategic_initiatives`, `partnerships`, `business_model`, `key_customers`, `management_profiles`, `employee_sentiment`, `product_sentiment`
Optional parameters to customize the output.
List of custom fields to compute for each company.
Name of the custom field (e.g. `"AI Readiness"`)
Data type of the field. Supported value: `text`
Prompt used to generate the custom field value (e.g. `"Rate this company's AI readiness on a scale of 1-10 with reasoning"`)
### 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": "3c945250-a3e8-4673-b342-2ceb03af5b02",
"status": "PENDING"
}
```
## OpenAPI
````yaml POST /api/enterprise/company/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/company/enrich/:
post:
tags:
- Enrichment
summary: Company Instant Enrichment (Batch)
description: >-
Delivers / data for one or more companies. Returns a `request_id` for
async polling.
operationId: companyEnrichBatch
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- companies
- sections
properties:
companies:
type: array
description: List of company permalinks or URLs to enrich.
items:
type: string
example:
- tesla-motors
- stripe
sections:
type: array
description: >-
Sections of data to include in the enrichment response.
Select one or more values.
uniqueItems: true
items:
type: string
enum:
- firmographics
- gtm_and_business_model
- headcount
- funding
- public_company_financials
- uk_private_company_financials
- acquisitions
- investments
- website_traffic
- products_and_services
- product_launches
- strategic_initiatives
- partnerships
- business_model
- key_customers
- management_profiles
- employee_sentiment
- product_sentiment
example:
- firmographics
parameters:
type: object
description: Optional parameters to customize the output.
properties:
custom_fields:
type: array
description: List of custom fields to compute for each company.
items:
type: object
required:
- field_name
- type
- prompt
properties:
field_name:
type: string
description: Name of the custom field.
example: AI Readiness
type:
type: string
description: Data type of the field.
enum:
- text
example: text
prompt:
type: string
description: Prompt used to generate the custom field value.
example: >-
Rate this company's AI readiness on a scale of
1-10 with reasoning
example:
companies:
- tesla-motors
- stripe
sections:
- firmographics
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.
````