Skip to main content
GET
Get Engine Config

Authorizations

Authorization
string
header
required

Send the key as Authorization: Bearer <key>. Two kinds of key exist.

Organization keys are issued in the portal (Settings, then API keys), each bound to one environment, shaped nx_<environment slug>_<64 hex>. They carry no capabilities and pass every capability check, with one exception: routes under /records, /actions, /operations, /api/v1/engines/{id}/opportunities, /api/v1/graph and /api/v1/catalog/documents accept an organization key only when its environment is live, and refuse any other with 403 scoped_key_required. Revocation takes effect within 60 seconds.

Scoped keys are issued by Nexio on request, shaped nxsk_v1_<24 hex key id>_<43 character secret>. Each is bound to one org, one environment, a set of engines and a set of capabilities. A malformed, unknown or revoked nxsk_ key fails with 401 and is never retried as an organization key. Revocation takes effect on the next request. A scoped key without a route's capability gets 403 insufficient_capability; a scoped key not bound to the engine gets 403 engine_binding_forbidden.

Key-grantable capabilities: engines:read, runs:write, runs:read, runs:defensibility:read, runs:test, catalog:read, catalog:documents:read, webhooks:manage, conversations:use, conversations:export, records:read, records:opportunities:run, actions:write, actions:read, graph:read, records:analyze.

Routes that accept organization keys only (every scoped key gets 403 insufficient_capability): environment management, engine create, update, configuration and publish, and conversation instance authoring. Each operation description names the capability a scoped key needs.

Path Parameters

engine_slug
string
required

Engine identifier slug (e.g. default).

Response

Engine configuration.

Engine configuration with audit metadata. The config structure varies by engine_type. The per-engine Contract page on platform.usenexio.com is the integration guide for your engine's typed request schema.

config
object
required

Engine configuration object. Structure depends on engine_type.

config_updated_at
string<date-time> | null
required

When the config was last saved (creating the engine counts as a save). null when no save time is recorded.

config_updated_by
string | null
required

Who last saved the config, for example the API key ID for an API save. null when none is recorded.

engine_type
enum<string>
required

Engine type. Includes the retired converse and property_risk values, which cannot be created but are still readable on engine rows that predate their retirement.

Available options:
comparison,
matching,
entity_analysis,
diligence,
triage,
opportunity,
converse,
property_risk
preset
object | null
required

Default configuration template for this engine type. Null when the engine type has no registered default, which is the case for the retired converse and property_risk types.

request_schema
object

Typed request schema for engine types whose run input is a typed structure. Omitted otherwise.

Last modified on September 25, 2026