Skip to main content

​
Overview

The Opus Job Operator API allows external applications to programmatically initiate, execute, and monitor any workflow managed by the Opus platform. The API supports a full range of data inputs, including:
  • Text and numbers
  • Booleans and dates
  • Objects and lists
  • Single and multiple file uploads

​
Base URL

All API requests should be made to the following base URL: 
https://operator.opus.com

​
Authentication

All API endpoints require authentication using the x-service-key header. 
x-service-key: <your_service_key>
Your API key is a unique, secret credential. Store it securely and never expose it in client-side code.

​
Job Execution Flow

The typical workflow for executing a job through the API follows these steps:
1

Get Workflow Schema

Retrieve the workflow’s input schema using GET /workflow/{workflow_id} to understand what inputs are required.
2

Initiate Job

Create a new job instance using POST /job/initiate and receive a jobExecutionId.
3

Upload Files (if needed)

If your workflow requires file inputs, upload them using POST /job/file/upload and the presigned URL flow.
4

Execute Job

Run the workflow with your populated inputs using POST /job/execute.
5

Monitor Status

Check the job’s progress using GET /job/{jobExecutionId}/status.
6

Retrieve Results

Once completed, fetch the results using GET /job/{jobExecutionId}/results.

​
Available Endpoints

Get Workflow Details

Retrieve workflow schema and input requirements

Initiate Job

Create a new job instance

Upload Files

Upload files for workflow inputs

Execute Job

Run a workflow with populated inputs

Get Job Status

Check job execution progress

Get Job Results

Retrieve completed job outputs

Job Audit Log

Access timestamped execution records