Skip to main content
POST
/
api
/
workflow_manager
/
start
const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "your token");

const raw = JSON.stringify({
  "workflow": "industry_custom_fc44748",
  "industry_research_topic": "Electric vehicles"
});

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

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

{
    "report_id": 86220
}

​
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

​
token
string
required
JWT token obtained from the Authentication request

​
Body Parameters

​
workbook_name
string
Name with which the workbook will be saved
​
workflow
string
required
Your workflow ID from the dashboard URL (e.g., comp_research_f312g from app.wokelo.ai/dashboard/workflows/comp_research_f312g/)
​
permalink
string
required
Crunchbase permalink of the company. Required for company-based workflows.
​
website
string
required
Website of the company. Required for company-based workflows.
​
industry_research_topic
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)
​
custom_files
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

​
report_id
integer
Report id for the initiated custom report
const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "your token");

const raw = JSON.stringify({
  "workflow": "industry_custom_fc44748",
  "industry_research_topic": "Electric vehicles"
});

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

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

{
    "report_id": 86220
}