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"
      },
      "{VARIABLE_NAME_2}": {
        "value": 45.8,
        "type": "float"
      }
    }
  }'
{
  "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
The job payload schema with values populated 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"
      },
      "{VARIABLE_NAME_2}": {
        "value": 45.8,
        "type": "float"
      }
    }
  }'
{
  "success": true,
  "message": "Job execution has been started",
  "jobExecutionId": "{JOB_EXECUTION_ID}",
  "jobPayloadSchemaInstance": {
    "{VARIABLE_NAME_1}": "{STRING_VALUE}",
    "{VARIABLE_NAME_2}": "{FILE_URL}"
  }
}