Skip to main content
POST
/
api
/
enterprise
/
company
/
enrich
const myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer Token");
myHeaders.append("Content-Type", "application/json");

const raw = JSON.stringify({
  "companies": [
    "tesla-motors",
    "stripe"
  ],
  "sections": [
    "products_and_services",
    "product_launches"
  ],
  "parameters": {
    "custom_fields": [
      {
        "field_name": "AI Readiness",
        "type": "text",
        "prompt": "Rate this company's AI readiness on a scale of 1-10 with reasoning"
      }
    ]
  }
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("{{path}}/api/enterprise/company/enrich/", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

{
    "request_id": "3c945250-a3e8-4673-b342-2ceb03af5b02",
    "status": "PENDING"
}

​
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 in 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

​
Request Parameters

​
Header Parameters

​
Authorization
string
required
JWT token obtained from the Authentication request
​
Content-Type
string
required
Must be application/json

​
Body Parameters

​
companies
array of strings
required
List of permalinks/ URLs of the companies (e.g. "tesla-motors", "stripe" OR "https://tesla.com")
​
sections
array of strings
required
Sections of data to include in the output. Supported values: products_and_services, product_launches, strategic_initiatives, partnerships, business_model, key_customers, management_profiles, employee_sentiment, product_sentiment
​
parameters.custom_fields
array of objects
List of custom fields to compute for each company
​
parameters.custom_fields[].field_name
string
Name of the custom field. Required if custom_fields is used.
​
parameters.custom_fields[].type
string
Data type of the field (e.g. text). Supported Value: text. Required if custom_fields is used.
​
parameters.custom_fields[].prompt
string
Prompt used to generate the custom field value. Required if custom_fields is used.
Example Body 
{
    "companies": [
        "tesla-motors",
        "stripe"
    ],
    "sections": [
        "products_and_services",
        "product_launches"
    ],
    "parameters": {
        "custom_fields": [
            {
                "field_name": "AI Readiness",
                "type": "text",
                "prompt": "Rate this company's AI readiness on a scale of 1-10 with reasoning"
            }
        ]
    }
}

​
Response

Successful response will include the request_id along with its status

​
Successful Response Fields

​
request_id
string
Request ID of the initiated request
​
status
string
Status of the request
const myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer Token");
myHeaders.append("Content-Type", "application/json");

const raw = JSON.stringify({
  "companies": [
    "tesla-motors",
    "stripe"
  ],
  "sections": [
    "products_and_services",
    "product_launches"
  ],
  "parameters": {
    "custom_fields": [
      {
        "field_name": "AI Readiness",
        "type": "text",
        "prompt": "Rate this company's AI readiness on a scale of 1-10 with reasoning"
      }
    ]
  }
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("{{path}}/api/enterprise/company/enrich/", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

{
    "request_id": "3c945250-a3e8-4673-b342-2ceb03af5b02",
    "status": "PENDING"
}