Skip to main content
POST
https://operator.opus.com
/
job
/
initiate
curl --request POST \
  --url https://operator.opus.com/job/initiate \
  --header 'Content-Type: application/json' \
  --header 'x-service-key: {YOUR_SERVICE_KEY}' \
  --data '{
    "workflowId": "{YOUR_WORKFLOW_ID}",
    "title": "Q4 Report Processing",
    "description": "Processing quarterly financial reports"
  }'

{
  "jobExecutionId": "{JOB_EXECUTION_ID}"
}
This step creates a job instance in the system and returns the unique ID jobExecutionId required for execution and monitoring.
You must save the jobExecutionId returned by this endpoint for all subsequent steps.

​
Headers

​
x-service-key
string
required
Your API authentication key

​
Body Parameters

​
workflowId
string
required
The ID of the workflow to be used for your job
​
title
string
required
Your chosen job title
​
description
string
required
Your chosen job description

​
Response

​
jobExecutionId
string
required
The unique identifier for this job execution. Use this ID in all subsequent API calls.
curl --request POST \
  --url https://operator.opus.com/job/initiate \
  --header 'Content-Type: application/json' \
  --header 'x-service-key: {YOUR_SERVICE_KEY}' \
  --data '{
    "workflowId": "{YOUR_WORKFLOW_ID}",
    "title": "Q4 Report Processing",
    "description": "Processing quarterly financial reports"
  }'

{
  "jobExecutionId": "{JOB_EXECUTION_ID}"
}