POST
/
flows
/
file
/
{flowId}
import Worqhat from 'worqhat';

const client = new Worqhat({
  apiKey: 'My API Key',
});

const response = await client.flows.triggerWithFile('f825ab82-371f-40cb-9bed-b325531ead4a');

console.log(response.data);
{
  "success": true,
  "message": "Workflow triggered successfully with file upload",
  "timestamp": "2025-07-26T03:28:08.123Z",
  "data": {
    "workflow_status": "started",
    "additional_data": "from backend response"
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Format - "Bearer YOUR_API_KEY"

Path Parameters

​
flowId
string
required

ID of the workflow to trigger

Example:

"f825ab82-371f-40cb-9bed-b325531ead4a"

Body

multipart/form-data

File upload or URL to process

​
file
file
required

File to upload and process

​
url
string<uri>

URL to a file to download and process

Example:

"https://example.com/path/to/file.pdf"

​
{key}
string

Additional form fields to include with the request

Response

Workflow triggered successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Workflow triggered successfully with file upload"

​
timestamp
string<date-time>
Example:

"2025-07-26T03:28:08.123Z"

​
data
object
Example:
{
  "workflow_status": "started",
  "additional_data": "from backend response"
}