Check flag | SchematicHQ

import { SchematicClient } from "@schematichq/schematic-typescript-node";
async function main() {
    const client = new SchematicClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.features.checkFlag("key", {});
}
main();

{
  "data": {
    "flag": "premium_api_access",
    "reason": "User is entitled to use the premium API feature within current limits.",
    "value": true,
    "company_id": "comp_987654321",
    "entitlement": {
      "feature_id": "feat_12345",
      "feature_key": "premium_api_access",
      "value_type": "numeric",
      "allocation": 1000,
      "credit_id": "credit_abc123",
      "credit_remaining": 250.75,
      "credit_total": 1000,
      "credit_used": 749.25,
      "event_name": "api_calls",
      "metric_period": "current_month",
      "metric_reset_at": "2024-07-01T00:00:00Z",
      "month_reset": "billing_cycle",
      "soft_limit": 1200,
      "usage": 850
    },
    "error": "",
    "flag_id": "flag_67890",
    "rule_id": "rule_54321",
    "rule_type": "entitlement",
    "user_id": "user_123456",
    "feature_allocation": 1000,
    "feature_usage": 850,
    "feature_usage_event": "api_calls",
    "feature_usage_period": "current_month",
    "feature_usage_reset_at": "2024-07-01T00:00:00Z"
  },
  "params": {}
}

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Path parameters

keystringRequired

key

Request

This endpoint expects an object.

companymap from strings to strings or nullOptional

usermap from strings to strings or nullOptional

Response

dataobject

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error