Skip to main content

​
Overview

The Business Process Discovery API gives you programmatic access to the processes mapped in Opus Discovery. A discovered process is the structured record of how work actually happens: the steps, the order and branching between them, who performs each one, the systems touched, the rules applied, and the pain points recorded along the way. Use it to pull a process into your own tooling — reporting, audits, migration into another system, or as the input to a workflow you build elsewhere.

​
Base URL

All API requests should be made to the following base URL:

​
Authentication

All API endpoints require authentication with your Opus API key, sent in the x-service-key header.
Your key determines your identity: the acting user, your organization, and the workspaces you can reach. Reading a process additionally requires the Discovery: Read permission in the workspace that owns it. A request with a missing, invalid, or expired key returns 401. Keys are rate limited — sustained bursts return 429.
Your API key is a unique, secret credential. Store it securely and never expose it in client-side code.

​
Current State or a Saved Version

A process changes as it is refined. Every read is one of two things:
  • The current state — omit processVersionId. This is the live process as it stands right now.
  • A saved version — pass processVersionId to read the snapshot captured when that version was saved.
Both return the same response shape, so code written against one works against the other.

​
What a Process Contains

Steps

Ordered units of work, each with an owner, duration, status, and the inputs, outputs, systems, rules, departments, performers and pain points recorded on it

Edges

The connections between steps, including the branching paths

Process-level items

Inputs, outputs, systems and rules that apply to the process as a whole rather than a single step

Context

The country and industry the process belongs to

​
Available Endpoints

Get a Process

Retrieve a discovered process with its steps, edges and tagged items