Before running your first job programmatically on the Opus platform, you need to ensure the following prerequisites are in place.
Authentication & Base URL
All API requests must be made to the following base URL and include the x-service-key header for authentication.
- Base URL:
https://operator.opus.com
- Authentication Header:
x-service-key: <your_service_key>
Obtaining Your API Key
The x-service-key is your unique, secret API key for authenticating your requests. Follow these steps to generate one:
Navigate to Organization Settings
In the Opus platform, click the My Organization tab at the top of the screen.
Open Settings
Click the gear icon next to your Organization’s name to open its settings.
Access API Keys
From the settings menu on the left, select API Keys.
Generate New Key
Click the + Generate API Key button.
Name Your Key
A modal will appear. You can enter an optional Key Name for your reference.
Generate and Copy
Click the Generate Key button. Your new x-service-key will be displayed.This is the only time the key will be shown. You must copy this key immediately and store it in a secure location.
Manage Your Keys
After creation, your key will be listed in the API Keys panel. Here you can see its name, creation date, expiration date, and an option to Delete the key.
Finding Your Workflow ID
The workflow_id is the unique identifier for the specific workflow you want to trigger. This ID is found in the URL of your Opus environment.
You can find this ID in two common places:
From Workflow Details
From the Builder
Navigate to the Workflows tab in your Opus application, find your workflow, and click on it. The URL in your browser will show the ID.
Open your workflow in the Builder. The URL in your browser will also contain the ID.
app.opus.com/app/workflow/{workflow_id_here}
For example, in the URL app.opus.com/app/workflow/B9uGJfZ3CFwOdMKH, the Workflow ID is B9uGJfZ3CFwOdMKH.
Next Steps
Once you have your API key and workflow ID, you’re ready to start using the API:
