Create Engine
Create a new placement or entity-analysis engine in your organization.
Authorizations
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.
Body
URL-safe identifier. 3–50 lowercase alphanumeric characters and hyphens. Must start and end with an alphanumeric character.
3 - 50^[a-z0-9][a-z0-9-]*[a-z0-9]$Human-readable engine name.
1 - 100Engine type determines the config schema and pipeline behavior. This is the
creatable set. Any other value is rejected with invalid_engine_type; the
response enums are wider because retired types remain readable on existing rows.
placement, entity_analysis, diligence Optional engine description.
500Response
Engine created with default configuration.
Engine metadata returned by management endpoints.
Engine identifier.
URL-safe engine slug, unique within the organization.
Human-readable engine name.
Optional engine description.
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.
placement, entity_analysis, diligence, converse, property_risk Engine status. Archived engines cannot have their config updated.
active, archived 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.
RFC 3339 creation timestamp.
RFC 3339 last-update timestamp.