Skip to main content
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 
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'
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
}

​
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\"]"'

​
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'
List of possible statuses
StatusDescription
PENDINGRequest has been received and is queued for processing
PROCESSINGRequest is currently being processed
COMPLETEDRequest finished successfully — results are available
FAILEDRequest failed — check error details in the result endpoint
CANCELLEDRequest 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 '{{path}}/api/enterprise/request/cancel' \
--header 'Authorization: Bearer Token' \
--header 'Content-Type: application/json' \
--data '{
    "request_id": "5b8eff600-366f-465c-b795-68837043a2d3"
}'

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

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

​
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"
}'

​
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
}'