Skip to main content
POST
Custom Workflows

Overview

Run your pre-configured custom workflows to generate company or industry reports in your specific format.

Endpoint Details

  • Method: POST
  • Endpoint: /api/workflow_manager/start/

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

string
required
JWT token obtained from the Authentication request

Body Parameters

string
Name with which the workbook will be saved
string
required
Your workflow ID from the dashboard URL (e.g., comp_research_f312g from app.wokelo.ai/dashboard/workflows/comp_research_f312g/)
Crunchbase permalink of the company. Required for company-based workflows.
string
required
Website of the company. Required for company-based workflows.
string
required
For company workflows: Company’s industry (optional—leaves blank to use Wokelo’s auto-detected industry)For industry workflows: Industry to analyze (required)
array of objects
Files to include in the report—use fileName values from the upload response
Note: Either of company’s permalink or website is required for the company-based workflows

Response

Successful response will include the report_id of the custom report

Successful Response Fields

integer
Report id for the initiated custom report