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.
If you cannot find a company in the Wokelo database using this API, you can still use our APIs (except the Monitoring API) by passing the complete URL of the company’s website instead of its permalink.
GET /api/enterprise/company/search This is a synchronous API. Results are returned in the HTTP response itself.
Example response:

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 across other Wokelo APIs. POST /api/enterprise/company/add/ This is an asynchronous API. It returns a report_id, which you can track using the Report status 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

After the company is added

Track the request with the returned report_id using the Report status endpoint. Once it completes, search for the company with Company Search to get its permalink, and use that permalink 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/

Report lifecycle

Discovery and Workflow Automation APIs are asynchronous and return a report_id. Use these endpoints to track and export the report. See How Async APIs work.

Report status

Get the status of a report that was started using any Wokelo workflow API. GET /api/assets/get_notebook_status/
Example response:
List of possible statuses

Download report

Download a report once it has completed. POST /api/assets/download_report/

Report config

Retrieve the settings originally used to trigger a report. View the detailed API reference. POST /api/wkl/notebook/configuration/

Credits

APIs to check your current credit balance and review historical credit consumption.

Credit balance

Retrieve your account’s current credit balance, total allotted credits and account expiry period. GET /api/wkl/credits/get-credits-balance/
Example response:

Credit logs

Retrieve a paginated log of credit-consuming activity across the account, including reports, newsletters, API calls and assistant usage. GET /api/wkl/credits/get-credits-logs/ Query parameters
Example response:
Response fields Log entry fields