> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wokelo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 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

<ParamField header="Authorization" type="string" required>
  JWT token obtained from the Authentication request
</ParamField>

#### Body Parameters

<ParamField body="workbook_name" type="string">
  Name with which the workbook will be saved
</ParamField>

<ParamField body="workflow" type="string" required>
  Your workflow ID from the dashboard URL (e.g., `comp_research_f312g` from *app.wokelo.ai/dashboard/workflows/comp\_research\_f312g/*)
</ParamField>

<ParamField body="permalink" type="string" required>
  Crunchbase permalink of the company. Required for company-based workflows.
</ParamField>

<ParamField body="website" type="string" required>
  Website of the company. Required for company-based workflows.
</ParamField>

<ParamField body="industry_research_topic" type="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)
</ParamField>

<ParamField body="custom_files" type="array of objects">
  Files to include in the report—use `fileName` values from the upload response
</ParamField>

*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

<ResponseField name="report_id" type="integer">
  Report id for the initiated custom report
</ResponseField>

<ResponseExample>
  ```json 200 theme={"system"}
  {
      "report_id": 86220
  }
  ```
</ResponseExample>