Quickstart

Prerequisites

A LexQ account (sign up free)
An API key (created in Console → Management → API Keys)

Step 1: Create a Policy Group

Open the Console

Navigate to console.lexq.io and sign in.

Create a Group

Go to Policy Groups → Create Group.

Name: discount-policy
Priority: 0
Execution Mode: Allow All (NONE)

Create a Version

Inside your new group, click Create New Draft. This creates a DRAFT version where you can add rules.

Step 2: Define a Rule

Add a Rule

In the Rule Edit tab, click Add Rule.

Name: High-Value Discount
Priority: 0

Set the Condition

Add a condition using the payment_amount fact:

payment_amount >= 100000

Add an Action

Add a MUTATE_FACT action:

Reference Fact (refVar): payment_amount
Operator (operator): SUB (subtract from refVar)
Method: Percentage
Rate: 10 (reduces refVar by 10%)

user_id, user_tags are system facts — pre-registered and ready to use. Domain-specific facts like payment_amount or customer_tier are user-defined — see Fact Definitions.

Step 3: Test with Dry Run

Before deploying, validate your rule with a Dry Run:

curl -X POST https://api.lexq.io/api/v1/partners/analytics/dry-run/versions/{versionId} \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "facts": {
        "payment_amount": 150000,
        "user_id": "user-001"
    },
    "includeDebugInfo": true,
    "mockExternalCalls": true
}'

You should see the mutated payment_amount: 135000 in the response, and payment_amount__delta: -15000 in generatedVariables (the signed change applied by the rule).

Step 4: Publish and Deploy

Publish

Click Publish Version. The version transitions from DRAFT to ACTIVE and is now locked — no further edits allowed.

Deploy

Click Deploy to Live. Enter a deployment memo and confirm. Your policy is now live and processing traffic.

Step 5: Execute via API

Call the execution endpoint from your application:

curl -X POST https://api.lexq.io/api/v1/execution/groups/{groupId} \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "facts": {
        "payment_amount": 150000,
        "user_id": "user-001"
    }
}'

HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.lexq.io/api/v1/execution/groups/" + groupId))
.header("x-api-key", apiKey)
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString("""
{
    "facts": {
        "payment_amount": 150000,
        "user_id": "user-001"
    }
}
"""))
.build();

const response = await fetch(
`https://api.lexq.io/api/v1/execution/groups/${groupId}`,
{
    method: "POST",
    headers: {
        "x-api-key": apiKey,
        "Content-Type": "application/json",
    },
    body: JSON.stringify({
        facts: {
            payment_amount: 150000,
            user_id: "user-001",
        },
    }),
}
);

What’s Next?

Fact Definitions

Add custom variables like customer_tier or order_region.

Impact Simulation

Test policies against bulk data before deploying.

Policy Execution

Learn about all 4 execution modes (single, version, batch, composite).

CLI & MCP

Manage policies from the terminal or via AI agents.

Getting Started

Core Concepts

Features

Prerequisites

Step 1: Create a Policy Group

Step 2: Define a Rule

Step 3: Test with Dry Run

Step 4: Publish and Deploy

Step 5: Execute via API

What’s Next?

Fact Definitions

Impact Simulation

Policy Execution

CLI & MCP

​Prerequisites

​Step 1: Create a Policy Group

​Step 2: Define a Rule

​Step 3: Test with Dry Run

​Step 4: Publish and Deploy

​Step 5: Execute via API

​What’s Next?

Fact Definitions

Impact Simulation

Policy Execution

CLI & MCP

Prerequisites

Step 1: Create a Policy Group

Step 2: Define a Rule

Step 3: Test with Dry Run

Step 4: Publish and Deploy

Step 5: Execute via API

What’s Next?