Workflow Automation

Start Workflow

Starts generating a report for a given workflow type. Pass the appropriate workflow value to trigger Company Research, Industry Research, Peer Comparison, or a Custom Workflow. Returns a report_id to track and download the report.

Workflow values:

  • company_primer – Company Research
  • industry_primer – Industry Research
  • player_comparison – Peer Comparison
  • Your custom workflow ID (e.g. comp_research_f312g) – Custom Workflows
post/api/workflow_manager/start/

Request

  • Base URL: https://api.wokelo.ai
  • URL: https://api.wokelo.ai/api/workflow_manager/start/
  • Auth: HTTP bearer

Request body

workflowstring required

Workflow identifier. Use company_primer, industry_primer, player_comparison, or your custom workflow ID from the dashboard URL.

permalinkstring

Crunchbase permalink of the company. Required for company-based workflows (either permalink or website must be provided).

websitestring

Website of the company. Required for company-based workflows (either permalink or website must be provided).

websitesstring[]

Array of company websites to compare. Required for player_comparison workflow.

industrystring

Company's industry. If not provided for company workflows, Wokelo will auto-detect it.

industry_research_topicstring

For industry workflows: the industry to analyze (required). For company workflows: the company's industry (optional).

workbook_namestring

Name with which the workbook will be saved.

custom_filesstring[]

Files to include in the report. Use fileName values from the Upload File response.

Example request

{
  "workflow": "company_primer",
  "permalink": "wokelo-ai",
  "website": "wokelo.ai",
  "websites": [
    "stripe.com",
    "paypal.com"
  ],
  "industry": "Fintech",
  "industry_research_topic": "Electric vehicles",
  "workbook_name": "Wokelo AI - Company Research",
  "custom_files": [
    "file_116e55ec-041d-4c1e-897c-3adef1576a09"
  ]
}

Response

Workflow started successfully. Returns the report_id to use with Get Report Status and Download Report.

report_idinteger

Report ID for the initiated workflow report.

Example response

{
  "report_id": 123345
}

Changes

No recorded changes to this operation across all 1 revision of this API.