> ## Documentation Index > Fetch the complete documentation index at: /llms.txt > Use this file to discover all available pages before exploring further. # API Reference > Schema-backed reference for every Decision Engine endpoint, with request/response models and an interactive playground. # API Reference This is the schema-backed reference for every Decision Engine endpoint. Each page below shows the full request and response model and includes an interactive playground, generated from the OpenAPI contract. Looking for copy-paste examples and end-to-end flows instead? Start with the [API Guide](/decision-engine-api-reference/api-reference/guides/api-ref.md). ## Two ways to read the API | Surface | Best for | | - | - | | [API Guide](/decision-engine-api-reference/api-reference/guides/api-ref.md) | Task-oriented `curl` examples, complete flows, and request variants. | | API Reference (this section) | Exact request/response schemas and an interactive playground, one page per endpoint. | For advanced rule examples — AND, OR, nested AND+OR, `volume_split_priority`, enum arrays, and number-array matching — see the [Advanced Routing Example](/decision-engine-api-reference/api-reference/guides/configure-routing/routing-advanced-example.md). For the exact `POST /routing/create` schema, use [Create Routing Rule](/decision-engine-api-reference/api-reference/endpoint/routing-rules/createRoutingRule.md). ## Access classes | Class | Routes | Authentication | | - | - | - | | Public | `GET /health`, `GET /health/ready`, `GET /health/diagnostics`, `POST /auth/signup`, `POST /auth/login` | None | | Admin bootstrap | `POST /merchant-account/create` | Admin secret | | Protected | All routing, decision, score update, rule config, API key, merchant read/delete, analytics, audit, config, and authenticated auth routes | `Authorization: Bearer ` or `x-api-key: ` | | Sandbox | Any Decision Engine route served through `https://sandbox.hyperswitch.io` | Same auth rules plus `x-feature: decision-engine` | ## Endpoint Families ### Health * [Health Check](/decision-engine-api-reference/api-reference/endpoint/health/healthCheck.md) * [Health Ready](/decision-engine-api-reference/api-reference/endpoint/health/healthReady.md) * [Health Diagnostics](/decision-engine-api-reference/api-reference/endpoint/health/healthDiagnostics.md) ### Auth And Onboarding * [Signup](/decision-engine-api-reference/api-reference/endpoint/auth/signup.md) * [Login](/decision-engine-api-reference/api-reference/endpoint/auth/login.md) * [Logout](/decision-engine-api-reference/api-reference/endpoint/auth/logout.md) * [Current User](/decision-engine-api-reference/api-reference/endpoint/auth/me.md) * [List User Merchants](/decision-engine-api-reference/api-reference/endpoint/auth/listUserMerchants.md) * [Switch Merchant](/decision-engine-api-reference/api-reference/endpoint/auth/switchMerchant.md) * [Onboard Merchant](/decision-engine-api-reference/api-reference/endpoint/auth/onboardMerchant.md) ### API Keys * [Create API Key](/decision-engine-api-reference/api-reference/endpoint/auth/createApiKey.md) * [List API Keys](/decision-engine-api-reference/api-reference/endpoint/auth/listApiKeys.md) * [Revoke API Key](/decision-engine-api-reference/api-reference/endpoint/auth/revokeApiKey.md) ### Merchant Account * [Create Merchant](/decision-engine-api-reference/api-reference/endpoint/merchant-account/createMerchant.md) * [Get Merchant](/decision-engine-api-reference/api-reference/endpoint/merchant-account/getMerchant.md) * [Delete Merchant](/decision-engine-api-reference/api-reference/endpoint/merchant-account/deleteMerchant.md) * [Get Merchant Debit Routing](/decision-engine-api-reference/api-reference/endpoint/merchant-account/getMerchantDebitRouting.md) * [Update Merchant Debit Routing](/decision-engine-api-reference/api-reference/endpoint/merchant-account/updateMerchantDebitRouting.md) ### Gateway Decision * [Decide Gateway](/decision-engine-api-reference/api-reference/endpoint/gateway-decision/decideGateway.md) * [Legacy Decision Gateway](/decision-engine-api-reference/api-reference/endpoint/compatibility/legacyDecisionGateway.md) * [Update Gateway Score](/decision-engine-api-reference/api-reference/endpoint/score-feedback/updateGatewayScore.md) * [Legacy Update Score](/decision-engine-api-reference/api-reference/endpoint/compatibility/legacyUpdateScore.md) ### Routing Rules * [Create Routing Rule](/decision-engine-api-reference/api-reference/endpoint/routing-rules/createRoutingRule.md) * [Activate Routing Rule](/decision-engine-api-reference/api-reference/endpoint/routing-rules/activateRoutingRule.md) * [Deactivate Routing Rule](/decision-engine-api-reference/api-reference/endpoint/routing-rules/deactivateRoutingRule.md) * [List Routing Rules](/decision-engine-api-reference/api-reference/endpoint/routing-rules/listRoutingRules.md) * [Get Active Routing Rule](/decision-engine-api-reference/api-reference/endpoint/routing-rules/getActiveRoutingRule.md) * [Evaluate Routing Rule](/decision-engine-api-reference/api-reference/endpoint/routing-rules/evaluateRoutingRule.md) * [Hybrid Routing](/decision-engine-api-reference/api-reference/endpoint/routing-rules/hybridRouting.md) ### Rule Configuration * [Create Rule Config](/decision-engine-api-reference/api-reference/endpoint/rule-configuration/createRuleConfig.md) * [Get Rule Config](/decision-engine-api-reference/api-reference/endpoint/rule-configuration/getRuleConfig.md) * [Update Rule Config](/decision-engine-api-reference/api-reference/endpoint/rule-configuration/updateRuleConfig.md) * [Delete Rule Config](/decision-engine-api-reference/api-reference/endpoint/rule-configuration/deleteRuleConfig.md) ### Config * [Get Routing Config](/decision-engine-api-reference/api-reference/endpoint/compatibility/getRoutingConfig.md) * [Configure SR Dimensions](/decision-engine-api-reference/api-reference/endpoint/compatibility/configSrDimension.md) ### Analytics * [Overview](/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsOverview.md) * [Gateway Scores](/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsGatewayScores.md) * [Decisions](/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsDecisions.md) * [Routing Stats](/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsRoutingStats.md) * [Log Summaries](/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsLogSummaries.md) * [Payment Audit](/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsPaymentAudit.md) * [Preview Trace](/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsPreviewTrace.md) * [Cost Savings](/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsCostSavings.md) * [Routing Events](/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsRoutingEvents.md) * [A/B Test Experiment Results](/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsExperimentResults.md) * [A/B Test Experiment Transactions](/decision-engine-api-reference/api-reference/endpoint/analytics/analyticsExperimentTransactions.md) ## Curl Examples For local and sandbox smoke-test examples, use [API Examples](/decision-engine-api-reference/api-reference/guides/api-ref.md).