Skip to main content
GET
Get Engine

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, conversations:use, and conversations:export. Operation descriptions name the required capability. Grandfathered nx_live_... and nx_test_... keys retain their existing broad access during the compatibility window.

Headers

Idempotency-Key
string

Optional run-submission key, at most 255 characters. The key is scoped to the organization, canonical environment, and submitting actor. Repeating the same request returns the existing run and does not enqueue another job. Reusing the key with a changed request returns 409 idempotency_key_reused. Keys live as long as the run row; no 24-hour expiry is promised.

Maximum string length: 255

Path Parameters

engine_slug
string
required

Engine identifier slug (e.g. default).

Response

Engine metadata.

Engine metadata returned by management endpoints.

id
string
required

Engine identifier.

slug
string
required

URL-safe engine slug, unique within the organization.

label
string
required

Human-readable engine name.

description
string
required

Optional engine description.

engine_type
enum<string>
required

Engine type. placement engines rank provider offerings into optimal solutions. entity_analysis engines evaluate a subject against requirements and find gaps. An entity_analysis engine whose released config declares an output contract runs in deterministic contract mode, which is how the property-risk preset ships (see Property risk engine). diligence engines verify a claimed event (location, date, what happened) and return a sourced verdict with an evidence chain.

converse and property_risk are retired: they cannot be created, and submitting a run against an engine that still carries one returns invalid_engine_type. They stay in this response enum because engine rows created before their retirement are still readable, so a client decoding a list or get response must tolerate them.

Available options:
placement,
entity_analysis,
diligence,
converse,
property_risk
status
enum<string>
required

Engine status. Archived engines cannot have their config updated.

Available options:
active,
archived
group_key
string
required

Key of the engine's semantic group within the organization, or an empty string when ungrouped. Groups label what an engine serves and carry handling guidance in their description; they never gate any operation.

created_at
string<date-time>
required

RFC 3339 creation timestamp.

updated_at
string<date-time>
required

RFC 3339 last-update timestamp.