Cases
Initiate Case
Create a new case for a workflow and receive a caseId
POST
This step creates a case for a workflow and returns the unique
caseId required for execution and monitoring. A case is a single run of a workflow.
Identify the workflow with the workflowId returned by the workflow endpoints. The case runs against the latest active version of the workflow unless you pin one with workflowVersionId or workflowVersionNumber.
Headers
string
required
Your API authentication key
Body Parameters
string
required
The workflow to run — the
workflowId UUID returned by the workflow endpoints.string
Pin the case to a specific workflow version by UUID. Omit to run the latest active version.
number
Pin the case to a specific workflow version by version number. Omit to run the latest active version.
string
Case title shown in the Opus UI
string
Case description shown in the Opus UI
Response
string
required
The unique identifier for this case. Use this ID in all subsequent API calls.
Errors
Unauthorized
Missing, invalid, or expired API key.
Not Found
The workflow does not exist.