---
title: "Start Workflow"
method: POST
path: "/api/workflow_manager/start/"
tags: ["Workflow Automation"]
---

# Start Workflow

`POST /api/workflow_manager/start/`

## Request

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

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

## Request body

- object
  - `workflow` string, required: Workflow identifier. Use `company_primer`, `industry_primer`, `player_comparison`, or your custom workflow ID from the dashboard URL.
  - `permalink` string: Crunchbase permalink of the company. Required for company-based workflows (either `permalink` or `website` must be provided).
  - `website` string: Website of the company. Required for company-based workflows (either `permalink` or `website` must be provided).
  - `websites` string[]: Array of company websites to compare. Required for `player_comparison` workflow.
  - `industry` string: Company's industry. If not provided for company workflows, Wokelo will auto-detect it.
  - `industry_research_topic` string: For industry workflows: the industry to analyze (required). For company workflows: the company's industry (optional).
  - `workbook_name` string: Name with which the workbook will be saved.
  - `custom_files` string[]: Files to include in the report. Use `fileName` values from the Upload File response.

## Response `200`

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

- object
  - `report_id` integer: Report ID for the initiated workflow report.

## Other responses

- `400`: Bad request – missing or invalid parameters
- `401`: Unauthorized – invalid or missing JWT token

---

[API](https://skmtc.dev/wokelo/apis/wokelo-api.md) · [All operations](https://skmtc.dev/wokelo/apis/wokelo-api/llms.txt) · [OpenAPI document](https://skmtc.dev/wokelo/apis/wokelo-api/revisions/78bebc3b5d6e?raw)