Skip to main content
Before running your first case 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/api/v1
  • 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:
1

Login to your Opus account

Open the Opus platform, and login to an account that has access to API Key.
2

Open API Key settings

Click the Opus button on the top left of your screen, you will find API under the Channels section.
3

Generate New Key

Click the + Generate API Key button.
4

Configure Your Key

A modal will appear. You need choose a unique Key Name for your reference, and set the Key Expiry.
5

Generate and Copy

Click the Generate 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.
6

Manage Your Keys

After creation, your key will be listed in the API page, under the Channels section. Here you can see its name, creation date, expiration date, last used 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:
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.
In both cases, the URL will follow this pattern:
For example, in the URL app.opus.com/app/workflow/9a0af3e5-dc8d-4d19-931d-34c1eeaca233, the Workflow ID is 9a0af3e5-dc8d-4d19-931d-34c1eeaca233. Workflow IDs are UUIDs.

​
Next Steps

Once you have your API key and workflow ID, you’re ready to start using the API:

Get Workflow Schema

Retrieve the input requirements for your workflow

Initiate Your First Case

Create a new case for your workflow