Supporting APIs - Wokelo Docs

Company Search

Search the Wokelo database by company name, website, or ticker symbol to retrieve permalinks and key attributes needed for other API calls. Note: If you are unable to find a company from the wokelo database using this API, you can still use our APIs (except Monitoring API) by using complete URL of the company’s website instead of its permalink. GET /api/enterprise/company/search NOTE: This is a synchronous API, which means the results will be returned in the HTTP response itself.

curl --location 'https://api.wokelo.ai/api/enterprise/company/search?query=wokelo&search_by=name&company_type=all' \
--header 'Authorization: Bearer Token' \
--header 'Content-Type: application/json'

import requests
import json

url = "https://api.wokelo.ai/api/enterprise/company/search?query=wokelo&search_by=name&company_type=all"

payload = json.dumps({
  "q": "wokelo"
})
headers = {
  'Authorization': 'Bearer Token',
  'Content-Type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Example response:

{
  "status": "success",
  "data": [
    {
      "name": "Wokelo AI",
      "permalink": "wokelo-ai",
      "short_description": "Wokelo builds purpose-built AI agents...",
      "founded_year": "2023",
      "ipo_status": "private",
      "hq": "Seattle, United States",
      "website": "https://www.wokelo.ai/",
      "ticker": "",
      "country_code": "US",
      "last_funding_round": "Seed"
    }
  ],
  "count": 1
}

Add Company

Add a company to the Wokelo database when it cannot be found using the Company Search API. Once added, the company becomes available for use across other Wokelo APIs via the returned permalink. POST /api/enterprise/company/add/ NOTE: This is an asynchronous API. After submitting a request, poll the Check status endpoint and retrieve the output using the Request result endpoint. Learn more about How Async APIs work.

Authentication

Uses the same authentication and headers as the Company Search API: a Bearer token in the Authorization header and Content-Type: application/json.

Request body

Parameter	Type	Required	Description
`company_name`	string	Yes	Name of the company to add.
`website`	string	Yes	Full URL of the company’s website.
`product_category`	string	No	Product or industry category of the company.
`company_type`	string	No	Type of the company. Accepted values: `Public`, `Private`.

curl --location 'https://api.wokelo.ai/api/enterprise/company/add/' \
--header 'Authorization: Bearer Token' \
--header 'Content-Type: application/json' \
--data '{
    "company_name": "Aditi Solar",
    "website": "https://aditisolar.in/"
}'

import requests
import json

url = "https://api.wokelo.ai/api/enterprise/company/add/"

headers = {
    "Authorization": "Bearer Token",
    "Content-Type": "application/json"
}

payload = {
    "company_name": "Aditi Solar",
    "website": "https://aditisolar.in/",
    "product_category": "Solar Energy",
    "company_type": "Private"
}

response = requests.post(url, headers=headers, data=json.dumps(payload))
print(response.json())

Response

The API returns a request_id that you use to poll for status and retrieve the result.

{
    "request_id": "89daf26a-ee17-4915-96da-19b52067068a",
    "status": "PENDING"
}

Retrieving the result

Once the request status is COMPLETED, use the Request result endpoint to fetch the output.

curl --location 'https://api.wokelo.ai/api/enterprise/request/result/?request_id=89daf26a-ee17-4915-96da-19b52067068a' \
--header 'Authorization: Bearer Token' \
--header 'Content-Type: application/json'

Example completed result:

{
    "request_id": "89daf26a-ee17-4915-96da-19b52067068a",
    "status": "COMPLETED",
    "result": {
        "status": "success",
        "permalink": "wokelo-aditisolar-in"
    },
    "credits_consumed": 0.0
}

The returned permalink can then be used as the company reference in other Wokelo API calls.

File upload

Upload your proprietary files to Wokelo to supplement research reports with internal data. Each uploaded file receives a unique identifier (fileName) that you reference in the custom_files parameter when creating reports. POST /api/assets/upload/

curl --location 'https://api.wokelo.ai/api/assets/upload/' \
--header 'Authorization: Bearer Token' \
--header 'Content-Type: application/json' \
--form 'files=@"/Users/sahilmalhotra/Downloads/lemonade_diligence.pdf"' \
--form 'files=@"/Users/sahilmalhotra/Downloads/lemonade.pdf"' \
--form 'fileUUID="[\"k3m8n5p1q6\", \"a7f4b9e2c3\"]"'

import requests
import json

url = "https://api.wokelo.ai/api/assets/upload/"

payload = {'fileUUID': '["k3m8n5p1q6", "a7f4b9e2c3"]'}
files=[
  ('files',('lemonade_diligence.pdf',open('/Users/sahilmalhotra/Downloads/lemonade_diligence.pdf','rb'),'application/pdf')),
  ('files',('lemonade.pdf',open('/Users/sahilmalhotra/Downloads/lemonade.pdf','rb'),'application/pdf'))
]
headers = {
  'Authorization': 'Bearer Token',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

Request lifecycle

Enrichment, Insights, and Company Grid APIs are all asynchronous. After submitting a request, use these endpoints to track and retrieve results.

Check status

This API can be used to check request status. GET /api/enterprise/request/status/

curl --location 'https://api.wokelo.ai/api/enterprise/request/status/?request_id=b1f10ebf-a251-4e2d-b867-8482ac701987' \
--header 'Authorization: Bearer Token' \
--header 'Content-Type: application/json'

import requests
import json

url = "https://api.wokelo.ai/api/enterprise/request/status/?request_id=11db67b6-8345-4837-950f-87bbd8d7dcbe"

payload = {}
headers = {
  'Authorization': 'Bearer Token',
  'Content-Type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

List of possible statuses

Status	Description
PENDING	Request has been received and is queued for processing
PROCESSING	Request is currently being processed
COMPLETED	Request finished successfully — results are available
FAILED	Request failed — check error details in the result endpoint
CANCELLED	Request was cancelled by the user

Cancel request

This API can be used to cancel a request that is already placed and is in “PENDING” or “PROCESSING” state. ** ** POST /api/enterprise/request/cancel

curl --location --globoff 'https://api.wokelo.ai/api/enterprise/request/cancel' \
--header 'Authorization: Bearer Token' \
--header 'Content-Type: application/json' \
--data '{
    "request_id": "5b8eff600-366f-465c-b795-68837043a2d3"
}'

import requests
import json

url = "https://api.wokelo.ai/api/enterprise/request/cancel"

payload = json.dumps({
  "request_id": "5b8eff600-366f-465c-b795-68837043a2d3"
})
headers = {
  'Authorization': 'Bearer Token',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Request result

This API helps you get the result of a request after its status is “COMPLETED”. GET /api/enterprise/request/result/

curl --location 'https://api.wokelo.ai/api/enterprise/request/result/?request_id=d7a78d10-663a-493f-9b79-be1e6094f3bb'

import requests

url = "https://api.wokelo.ai/api/enterprise/request/result/?request_id=d7a78d10-663a-493f-9b79-be1e6094f3bb"

payload = {}
headers = {
  'Authorization': 'Bearer Token'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Report lifecycle

Workflow APIs (Company Research, Industry Research, Peer Comparison, Custom) are asynchronous and produce downloadable reports. Use these endpoints to track and export them.

Report status

This API can be used to get the status of report that is already placed using any of the workflow APIs. GET /api/assets/get_notebook_status/

curl --location 'https://api.wokelo.ai/api/assets/get_notebook_status/?report_id=109196' \
--header 'Authorization: your token'

import requests

url = "https://api.wokelo.ai/api/assets/get_notebook_status/?report_id=109196"

payload = {}
headers = {
  'Authorization': 'your token'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Download report

This API can be used to download the report after its completed. Export Formats supported: “pdf”, “docx”, “ppt”, or “json”. Note: ppt format is only supported for company research, industry research reports.

curl --location 'https://api.wokelo.ai/api/assets/download_report/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer Token' \
--data '{
    "report_id": 109196,
    "file_type": "json"
}'

import requests
import json

url = "https://api.wokelo.ai/api/assets/download_report/"

payload = json.dumps({
  "report_id": 109196,
  "file_type": "json"
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer Token'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Report config

Retrieve the settings originally used to trigger a report. View detailed API reference.

POST api/wkl/notebook/configuration/

curl --location --globoff 'https://api.wokelo.ai/api/wkl/notebook/configuration/' \
--header 'Authorization: Bearer Token' \
--header 'Content-Type: application/json' \
--data '{
    "notebook_id": 103737
}'

import requests
import json

url = "https://api.wokelo.ai/api/wkl/notebook/configuration/"

payload = json.dumps({
  "notebook_id": 107303
})
headers = {
  'Authorization': 'Bearer Token',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

​Company Search

​Add Company

​Authentication

​Request body

​Response

​Retrieving the result

​File upload

​Request lifecycle

​Check status

​Cancel request

​Request result

​Report lifecycle

​Report status

​Download report

​Report config