Skip to main content
POST
/
flows
/
file
/
{flowId}
JavaScript
// Option 1: File Upload
const formData = new FormData();
const fileInput = document.querySelector('input[type="file"]');
formData.append('file', fileInput.files[0]);
formData.append('metadata', JSON.stringify({ key1: 'value1', key2: 'value2' }));

const response = await fetch(
  'https://api.worqhat.com/flows/file/f825ab82-371f-40cb-9bed-b325531ead4a',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    },
    body: formData
  }
);
const data = await response.json();

// Option 2: URL Input
const formData = new FormData();
formData.append('url', 'https://example.com/path/to/file.pdf');
formData.append('metadata', JSON.stringify({ key1: 'value1', key2: 'value2' }));

const response = await fetch(
  'https://api.worqhat.com/flows/file/f825ab82-371f-40cb-9bed-b325531ead4a',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    },
    body: formData
  }
);
const data = await response.json();
{
  "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

  • Option 1
  • Option 2
​
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"
}