Skip to main content
POST
/
api
/
v1
/
engines
/
{engine_slug}
/
runs
Submit Run
curl --request POST \
  --url https://api.usenexio.com/api/v1/engines/{engine_slug}/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {
    "address": {
      "state": "NY",
      "zip_code": "11231"
    },
    "coverage_types": [
      "auto"
    ],
    "appetite_bucket": "balanced"
  },
  "offerings": [
    {
      "id": "20260416-14.06.01.632319",
      "provider_id": "prog",
      "provider_name": "Progressive",
      "category": "auto",
      "attributes": {
        "line_of_business": "auto",
        "quoted_vehicle_count": 1,
        "term_months": 12,
        "line_premium_annual": 1445
      },
      "coverage": {
        "deductible_default": 500,
        "limit_combined_single": 300000
      }
    },
    {
      "id": "d4d5a3da-381c-40c8-b70d-39a1935af0cd",
      "provider_id": "safe",
      "provider_name": "Safeco",
      "category": "auto",
      "attributes": {
        "line_of_business": "auto",
        "quoted_vehicle_count": 1,
        "term_months": 12,
        "line_premium_annual": 7226
      },
      "coverage": {
        "deductible_default": 500,
        "limit_combined_single": 300000
      }
    },
    {
      "id": "90584063",
      "provider_id": "trvl",
      "provider_name": "Travelers",
      "category": "auto",
      "attributes": {
        "line_of_business": "auto",
        "quoted_vehicle_count": 1,
        "term_months": 12,
        "line_premium_annual": 2871
      },
      "coverage": {
        "deductible_default": 500,
        "limit_combined_single": 300000
      }
    }
  ]
}
'
{
  "run_id": "bcb87157-0bfc-404d-a120-7f5c9cd01037",
  "status": "queued"
}

Documentation Index

Fetch the complete documentation index at: https://docs.usenexio.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key with environment prefix. Use nx_test_... for sandbox and nx_live_... for production. Obtain keys at platform.usenexio.com/settings/api-keys.

Path Parameters

​
engine_slug
string
required

Engine identifier slug (e.g. default).

Body

application/json
​
input
object
required

Engine-specific submission context. Common fields for current Engine-specific submission context. The exact fields depend on your engine's configuration and domain. Common fields for current insurance engines include:

  • placement engines:
    • coverage_types — lines to evaluate: home, auto, umbrella
    • address.state — two-letter state code used in quote matching
    • applicant, drivers, vehicles_detail, residence
    • current_coverage — incumbent policies used for context, not ranked
    • insurance_history
    • appetite_bucket — ranking strategy
  • entity-analysis engines:
    • prospect.primary_address.state
    • current_portfolio
    • any additional fields required by that engine's generated contract Open the Contract page on platform.usenexio.com for your engine to see the exact request schema; the Copy-for-agents button yields a Markdown integration guide ready to paste into agent-tooling prompts.
​
offerings
object[]

Provider offerings — one entry per provider per requirement category. Required in practice for placement engines that rank quoted line items. Not typically used by entity-analysis engines.

​
engine_version
string

Optional. Pins which released engine version this run executes against, so your integration's behavior is stable across operator publishes.

  • "1.3" — exact version, frozen forever.
  • "1.x" — auto-track the latest released minor of major 1 (you ride non-breaking improvements; a breaking change ships as a new major you opt into explicitly).

Bare major ("1") and three-tier semver ("1.0.0") are rejected. Omit to run against the engine's current configuration. The resolved major.minor is echoed on the run and in webhook payloads.

Pattern: ^\d+\.(\d+|x)$
Example:

"1.x"

Response

Run accepted and queued for processing.

​
run_id
string<uuid>
required

Unique run identifier. Use this to poll for results.

​
status
enum<string>
required

Always queued on successful submission.

Available options:
queued