Skip to main content
To help you get started quickly, we provide a Postman Collection with pre-configured API requests for all Opus Job Operator endpoints.

Download Collection

Download Postman Collection

Get the complete collection with all API endpoints

Setup Instructions

1

Import the Collection

Open Postman and import the downloaded collection file.
2

Configure Base URL

Create a Postman environment or collection variable named base_url and set it to:
https://operator.opus.com
3

Add Authentication

Include your API key in the Headers tab of each request:
x-service-key: <your_service_key>
Alternatively, configure it as a collection-level variable for reuse across all requests.
4

Replace Placeholders

Update the following template values with your actual identifiers:
  • put_your_workflow_id_here → Your actual workflow ID
  • put_your_job_id_here → Your actual job execution ID

Included Requests

The collection contains pre-configured requests for:
EndpointMethodDescription
Get Workflow DetailsGETRetrieve workflow schema and input requirements
Initiate JobPOSTCreate a new job instance
Upload FilePOSTGenerate presigned file upload URL
Execute JobPOSTRun workflow with inputs
Get Job StatusGETCheck execution progress
Get Job ResultsGETRetrieve completed job outputs
Job Audit LogGETAccess execution history