Execute Case

curl --request POST \
  --url https://operator.opus.com/api/v1/case/{YOUR_CASE_ID}/execute \
  --header 'Content-Type: application/json' \
  --header 'x-service-key: {YOUR_SERVICE_KEY}' \
  --data '{
    "callbackUrl": "https://your-app.example.com/opus/callback",
    "payload": {
      "{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"
      }
    }
  }'

import requests

case_id = "{YOUR_CASE_ID}"
url = f"https://operator.opus.com/api/v1/case/{case_id}/execute"
headers = {
    "Content-Type": "application/json",
    "x-service-key": "{YOUR_SERVICE_KEY}"
}
payload = {
    "callbackUrl": "https://your-app.example.com/opus/callback",
    "payload": {
        "{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"
        }
    }
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const caseId = "{YOUR_CASE_ID}";
const response = await fetch(`https://operator.opus.com/api/v1/case/${caseId}/execute`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "x-service-key": "{YOUR_SERVICE_KEY}",
  },
  body: JSON.stringify({
    callbackUrl: "https://your-app.example.com/opus/callback",
    payload: {
      "{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",
      },
    },
  }),
});

const data = await response.json();
console.log(data);

{
  "success": true,
  "caseId": "{CASE_ID}",
  "message": "Job execution started"
}

POST

api

case

{caseId}

execute

curl --request POST \
  --url https://operator.opus.com/api/v1/case/{YOUR_CASE_ID}/execute \
  --header 'Content-Type: application/json' \
  --header 'x-service-key: {YOUR_SERVICE_KEY}' \
  --data '{
    "callbackUrl": "https://your-app.example.com/opus/callback",
    "payload": {
      "{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"
      }
    }
  }'

import requests

case_id = "{YOUR_CASE_ID}"
url = f"https://operator.opus.com/api/v1/case/{case_id}/execute"
headers = {
    "Content-Type": "application/json",
    "x-service-key": "{YOUR_SERVICE_KEY}"
}
payload = {
    "callbackUrl": "https://your-app.example.com/opus/callback",
    "payload": {
        "{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"
        }
    }
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const caseId = "{YOUR_CASE_ID}";
const response = await fetch(`https://operator.opus.com/api/v1/case/${caseId}/execute`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "x-service-key": "{YOUR_SERVICE_KEY}",
  },
  body: JSON.stringify({
    callbackUrl: "https://your-app.example.com/opus/callback",
    payload: {
      "{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",
      },
    },
  }),
});

const data = await response.json();
console.log(data);

{
  "success": true,
  "caseId": "{CASE_ID}",
  "message": "Job execution started"
}

This is the primary step where you provide all inputs and run the workflow.

Case execution is asynchronous. This endpoint returns immediately once the run is queued; the final result is delivered to your callbackUrl (and is also retrievable via Get Case Results).

The request body consists of:

The payload — the input schema from Get Workflow Details with values populated for each input
An optional callbackUrl that Opus will POST to when the case finishes

Path Parameters

string

required

The case ID returned by Initiate Case

Headers

string

required

Your API authentication key

Body Parameters

object

required

An object where each key is a variable name from your workflow’s input schema, and each value is a Variable Object (see below).

string

HTTPS URL that Opus will POST the case result to once the run finishes. Must be reachable from the Opus platform.

Variable Object

Each entry in payload uses your variable name as the key (e.g., VARIABLE_NAME_1) and maps to an object with the following properties:

any

required

The value for this input (type depends on field type)

string

required

The data type: str, float, bool, date, file, array, array_files, or object

object

Type definition of the variable, as provided by the workflow’s input schema.

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

boolean

required

Whether the case execution was successfully started

string

required

The case ID

string

required

Status message

object

Error payload if the case could not be started

Errors

Unauthorized

Missing, invalid, or expired API key.

Not Found

The case does not exist.

curl --request POST \
  --url https://operator.opus.com/api/v1/case/{YOUR_CASE_ID}/execute \
  --header 'Content-Type: application/json' \
  --header 'x-service-key: {YOUR_SERVICE_KEY}' \
  --data '{
    "callbackUrl": "https://your-app.example.com/opus/callback",
    "payload": {
      "{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"
      }
    }
  }'

import requests

case_id = "{YOUR_CASE_ID}"
url = f"https://operator.opus.com/api/v1/case/{case_id}/execute"
headers = {
    "Content-Type": "application/json",
    "x-service-key": "{YOUR_SERVICE_KEY}"
}
payload = {
    "callbackUrl": "https://your-app.example.com/opus/callback",
    "payload": {
        "{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"
        }
    }
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const caseId = "{YOUR_CASE_ID}";
const response = await fetch(`https://operator.opus.com/api/v1/case/${caseId}/execute`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "x-service-key": "{YOUR_SERVICE_KEY}",
  },
  body: JSON.stringify({
    callbackUrl: "https://your-app.example.com/opus/callback",
    payload: {
      "{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",
      },
    },
  }),
});

const data = await response.json();
console.log(data);

{
  "success": true,
  "caseId": "{CASE_ID}",
  "message": "Job execution started"
}

⌘I

Get Started

Workflows

Cases

Files

Deprecated

Path Parameters

Headers

Body Parameters

Variable Object

Response

Errors

​Path Parameters

​Headers

​Body Parameters

​Variable Object

​Response

​Errors

Path Parameters

Headers

Body Parameters

Variable Object

Response

Errors