- Placement engines — send offerings from multiple providers and get ranked solutions with multi-dimension scorecards
- Entity analysis engines — send a current portfolio or entity state and get gap analysis with severity-ranked recommendations
POST /api/v1/engines/{engine_slug}/runs, retrieve results via GET /api/v1/runs/{run_id} or webhooks.
Quickstart
You need an API key from Settings → API Keys. Keys are shown only once.nx_test_ = sandbox, nx_live_ = production.
1. Submit a run
This example uses a personal-lines insurance engine. Your engine’s input schema depends on its configuration — see the Headless Engine Setup guide.
202 Accepted:
2. Poll for results
GET /api/v1/runs/{run_id} until status is completed or failed. Start at 2s, backoff 1.5x, cap 30s.
3. Read the results
solutions[0].cluster_label— solution label (recommended,best_value, etc.)solutions[0].scorecard.overall_level— package score (lower is better)solutions[0].est_cost_low/est_cost_high— annual cost rangesolutions[0].offerings[*].provider_name— provider per line
Next steps
Key Concepts
Runs, offerings, solutions, scorecards, engine types.
Integration Guide
Offering structure, multi-provider input, failure cases.
API Reference
Full endpoint documentation with typed schemas.
Authentication
API key types, creation, and security.