Skip to main content
GoRules provides two services with REST APIs.

BRMS OpenAPI Spec

Download the BRMS API specification

Agent OpenAPI Spec

Download the Agent API specification

​
BRMS API

The Business Rules Management System (BRMS) API provides full access to manage your rules, projects, releases, environments, and users. Use this API to:
  • Manage projects and documents
  • Create and deploy releases
  • Configure environments
  • Evaluate decisions directly through BRMS
  • Administer users and permissions
The BRMS API requires authentication via Personal Access Token (PAT) or Evaluation Token depending on the endpoint.
The BRMS API is under active development. Some endpoints may change in future releases and response schemas may be incomplete or inaccurate. If you have integrations using the BRMS API, test them when upgrading to a new version.

​
Agent API

The Agent is a lightweight, high-performance service designed for rule evaluation at scale. It loads decision models from releases and executes them with minimal latency. Use the Agent API to:
  • Evaluate decisions in production environments
  • Handle high-throughput workloads
  • Deploy rules closer to your application
The Agent API requires authentication via Evaluation Token only.
For deployment options and configuration, see the Agent deployment guide.

​
Choosing between BRMS and Agent

Use CaseService
Managing rules and projectsBRMS
CI/CD integrationBRMS
Development and testingBRMS
Production rule evaluationAgent
High-throughput evaluationAgent
Low-latency requirementsAgent
For production workloads, we recommend using the Agent for evaluation while using the BRMS API for management operations.