Skip to main content
POST
Submit Run

Authorizations

Authorization
string
header
required

Send the credential as Authorization: Bearer <key>.

Scoped partner credentials use the exclusive nxsk_v1_... namespace. Each scoped key is bound at issuance to one organization, one canonical named environment, an explicit engine set, and a least-privilege capability set. A malformed, unknown, rotated, or revoked nxsk_ key fails closed and is never retried as a legacy key.

Capabilities used by this API are runs:write, runs:read, engines:read, catalog:read, webhooks:manage, runs:defensibility:read, runs:test, and converse:use. Operation descriptions name the required capability. Grandfathered nx_live_... and nx_test_... keys retain their existing broad access during the compatibility window.

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

Pins which released engine configuration and request/response schemas this run uses.

  • "1.3": exact released configuration and schemas.
  • "1.x": auto-track the latest released minor of major 1 (you ride minor releases only when the engine policy permits it).
  • "draft": mutable unpublished config, accepted only in a sandbox environment.

Bare major ("1") and three-tier semver ("1.0.0") are rejected. Omission resolves to the latest release only for legacy-policy engines. exact_required engines require an explicit N.M and reject N.x. The resolved exact version is stable for the run and is echoed by polling and webhooks.

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

"1.0"

test_scenario
enum<string>

Deterministic supported-version fixture. Requires a sandbox environment, a scoped key with runs:test, and an explicit exact engine_version present in the published registry. Fixture runs use zero provider egress and count against the monthly run cap.

Available options:
completed,
degraded,
failed

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