RuleOps
ProductFAQAPI
RuleOps API Reference

Build against live decision rules

Use the menu to move between setup guidance, production behavior, reference data, and every public endpoint.

API setup
API menu

Guides and endpoints.

Start here
Rules
Decisions
Libraries

Base URL

/api/v1
Overview

RuleOps exposes a small server-side API for discovering published rules, evaluating a rule in your product flow, reading the persisted decision trace, and syncing reference library values used by rule fields.

1. Authenticate

Send your live key as a Bearer token from your backend.

2. Discover schema

Read rule fields, required inputs, and any field-specific library codes.

3. Evaluate

Send validated inputs to the rule evaluator and store the trace id.

4. Audit

Load decision traces later for support, reconciliation, and review.

Base URL

/api/v1

Endpoint map

The MVP API is intentionally compact. Use the menu for full request and response docs.

Rules

GET
List published rules
/rules
GET
Get a rule
/rules/{rule_id}
POST
Evaluate a rule
/rules/{rule_id}/evaluate

Decisions

GET
Get a decision
/decisions/{trace_id}

Libraries

GET
List libraries
/libraries
GET
Get a library
/libraries/{library_code}
GET
List library records
/libraries/{library_code}/records

Conventions

Responses are JSON and return no-store cache headers.

Rules use the latest published version unless a version is pinned. Pin a version in production when input-schema changes should require an explicit integration update.

Archived rules cannot be discovered, retrieved, or evaluated.

Decisions are always Approve, Reject, Review, Escalate, or Custom. A Custom decision carries its configured value in output.message.

Library-backed rule fields expect record codes from their own library, not display names.

Evaluate supports idempotency for retry-safe business actions.

Primary evaluation path

/api/v1/rules/{rule_id}/evaluate

Use this inside your application workflow when RuleOps must make or explain a decision.