opus-02-quickstart-guide.md•2.27 kB
# Quickstart Guide

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`](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:
1. In the Opus platform, navigate to your Organization settings by clicking the **My Organization** tab at the top of the screen.
2. Click the **gear icon** next to your Organization's name to open its settings.
3. From the settings menu on the left, select **API Keys**.
4. Click the **+** **Generate API Key** button.
5. A modal will appear. You can enter an optional **Key Name** for your reference.
6. Click the **Generate Key** button.
7. 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.
8. 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:
1. **From the Workflow Details Page:** 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.
2. **From the Canvas Builder:** Open your workflow in the builder canvas. The URL in your browser will also contain the ID.
In both cases, the URL will follow this pattern. The Workflow ID is the value immediately after `.../workflow/`.
Your URL will look like: `app.opus.com/app/workflow/{workflow_id_here}`
For example, in the URL `app.opus.com/app/workflow/B9uGJfZ3CFwOdMKH`, the Workflow ID is `B9uGJfZ3CFwOdMKH`.