Quickstart

This guide walks you through making your first policy evaluation call. You will need an API key and a tenant ID.

Prerequisites

A MeshQu account with at least one tenant.
An API key with the decisions:evaluate scope.
Node.js 18+ (for the SDK path) or any HTTP client (for the raw API path).

Option A: Using the TypeScript SDK

The MeshQu SDK is in early access and not yet publicly distributed. Contact contact@meshqu.com for access.

1. Initialise the client

import { MeshQuClient } from '@meshqu/client';

const client = new MeshQuClient({
  baseUrl: 'https://api.meshqu.com',
  tenantId: 'your-tenant-id',
  apiKey: 'your-api-key',
});

2. Evaluate a decision

const result = await client.evaluate({
  decision_type: 'trade_execution',
  fields: {
    account_id: 'ACC-001',
    instrument: 'AAPL',
    quantity: 100,
  },
  metadata: { source: 'quickstart-example' },
});

console.log(result.result.decision); // 'ALLOW' | 'REVIEW' | 'DENY' | 'ALERT'
console.log(result.result.violations); // [] if ALLOW

The SDK returns the full evaluate envelope, so the verdict lives at result.result.decision. When you call the REST API directly (Option B), the same envelope is the JSON body itself, so the verdict is at result.decision. Both are correct — the extra result. in the SDK path is just the response object wrapping the envelope.

3. Act on the decision

if (result.result.decision === 'ALLOW') {
  // Proceed with the operation
} else if (result.result.decision === 'REVIEW') {
  // Queue for manual review
} else {
  // Block the operation and surface violations
  console.error('Blocked:', result.result.violations);
}

Option B: Using the REST API directly

1. Evaluate (dry-run, records no decision)

curl -X POST https://api.meshqu.com/v1/decisions/evaluate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-MeshQu-Tenant-Id: YOUR_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "context": {
      "decision_type": "trade_execution",
      "fields": {
        "account_id": "ACC-001",
        "instrument": "AAPL",
        "quantity": 100
      },
      "metadata": { "source": "quickstart-example" }
    }
  }'

2. Response

{
  "result": {
    "dry_run": true,
    "decision": "ALLOW",
    "violations": [],
    "rules_evaluated": 3,
    "evaluation_time_ms": 8.4,
    "timestamp": "2025-01-15T10:30:00.000Z",
    "policy_snapshot_id": "11111111-1111-1111-1111-111111111111",
    "evaluated_rules_hash": "2c26b46b68ffc68ff99b453c1d30413413422...sha256",
    "integrity_hash": "6f1ed002ab5595859014ebf0951522...sha256"
  },
  "snapshot": {
    "id": "11111111-1111-1111-1111-111111111111",
    "hash": "2c26b46b68ffc68ff99b453c1d30413413422...sha256",
    "rules_count": 3,
    "policies_count": 1,
    "cached": true
  },
  "duration_ms": 12.7,
  "shadow_mode": {
    "enabled": false
  },
  "governance_source": {
    "tenant_id": "tenant-uuid",
    "tenant_name": "Acme Trading",
    "level": 0
  }
}

result.dry_run is always true here, and appears on no recorded receipt. The result is deliberately unsigned — a preview the platform has not recorded and does not attest to. integrity_hash is reproducible, so you can recompute it, but on this endpoint nothing signs it.

3. Record a decision (persisted for audit)

If you want the decision stored, use /v1/decisions/record with an idempotency key:

curl -X POST https://api.meshqu.com/v1/decisions/record \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-MeshQu-Tenant-Id: YOUR_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "context": {
      "decision_type": "trade_execution",
      "fields": {
        "account_id": "ACC-001",
        "instrument": "AAPL",
        "quantity": 100
      },
      "metadata": { "source": "quickstart-example" }
    },
    "options": {
      "idempotency_key": "order-12345"
    }
  }'

The response includes decision.id for the persisted decision and is_new: true on first submission (or is_new: false if the idempotency key was already used).

Next steps

Authentication — understand API key scopes.
API Reference — explore all endpoints.
Integration Patterns — common architectures.

Getting Started

Concepts

API Reference

SDK

Guides

Recipes

Security

Meta

Prerequisites

Option A: Using the TypeScript SDK

1. Initialise the client

2. Evaluate a decision

3. Act on the decision

Option B: Using the REST API directly

1. Evaluate (dry-run, records no decision)

2. Response

3. Record a decision (persisted for audit)

Next steps

​Prerequisites

​Option A: Using the TypeScript SDK

​1. Initialise the client

​2. Evaluate a decision

​3. Act on the decision

​Option B: Using the REST API directly

​1. Evaluate (dry-run, records no decision)

​2. Response

​3. Record a decision (persisted for audit)

​Next steps

Prerequisites

Option A: Using the TypeScript SDK

1. Initialise the client

2. Evaluate a decision

3. Act on the decision

Option B: Using the REST API directly

1. Evaluate (dry-run, records no decision)

2. Response

3. Record a decision (persisted for audit)

Next steps