Skip to main content
POST
https://operator.opus.com
/
job
/
execute
curl --request POST \
  --url https://operator.opus.com/job/execute \
  --header 'Content-Type: application/json' \
  --header 'x-service-key: {YOUR_SERVICE_KEY}' \
  --data '{
    "jobExecutionId": "{YOUR_JOB_EXECUTION_ID}",
    "jobPayloadSchemaInstance": {
      "{VARIABLE_NAME_1}": {
        "value": "API Test Project",
        "type": "str",
        "displayName": "Variable Name 1"
      },
      "{VARIABLE_NAME_2}": {
        "value": 45.8,
        "type": "float",
        "displayName": "Variable Name 2"
      }
    }
  }'

{
  "success": true,
  "message": "Job execution has been started",
  "jobExecutionId": "{JOB_EXECUTION_ID}",
  "jobPayloadSchemaInstance": {
    "{VARIABLE_NAME_1}": "{STRING_VALUE}",
    "{VARIABLE_NAME_2}": "{FILE_URL}"
  }
}
This is the primary step where you provide all inputs and run the workflow. The request body consists of:

​
Headers

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

​
Body Parameters

​
jobExecutionId
string
required
The ID of the job to execute (received from Initiate Job)
​
jobPayloadSchemaInstance
object
required
An object where each key is a variable name from your workflow schema, and each value is a Variable Object (see below).

​
Variable Object

Each entry in jobPayloadSchemaInstance uses your variable name as the key (e.g., VARIABLE_NAME_1) and maps to an object with the following properties:
​
value
any
required
The value for this input (type depends on field type)
​
type
string
required
The data type: str, float, bool, date, file, array, array_files, or object
​
displayName
string
The variable name displayed in the Opus platform UI
While displayName is optional, omitting it may cause display glitches on the Opus platform UI. We strongly recommend including it for each input field.

​
Response

​
success
boolean
required
Whether the job execution was successfully started
​
message
string
required
Status message
​
jobExecutionId
string
required
The job execution ID
​
jobPayloadSchemaInstance
object
The populated input values (echoed back for confirmation)
curl --request POST \
  --url https://operator.opus.com/job/execute \
  --header 'Content-Type: application/json' \
  --header 'x-service-key: {YOUR_SERVICE_KEY}' \
  --data '{
    "jobExecutionId": "{YOUR_JOB_EXECUTION_ID}",
    "jobPayloadSchemaInstance": {
      "{VARIABLE_NAME_1}": {
        "value": "API Test Project",
        "type": "str",
        "displayName": "Variable Name 1"
      },
      "{VARIABLE_NAME_2}": {
        "value": 45.8,
        "type": "float",
        "displayName": "Variable Name 2"
      }
    }
  }'

{
  "success": true,
  "message": "Job execution has been started",
  "jobExecutionId": "{JOB_EXECUTION_ID}",
  "jobPayloadSchemaInstance": {
    "{VARIABLE_NAME_1}": "{STRING_VALUE}",
    "{VARIABLE_NAME_2}": "{FILE_URL}"
  }
}