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, 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).

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 current state against requirements and find gaps. diligence engines verify a claimed event (location, date, what happened) and return a sourced verdict with an evidence chain.

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

Engine status. Archived engines cannot have their config updated.

Available options:
active,
archived
created_at
string<date-time>
required

RFC 3339 creation timestamp.

updated_at
string<date-time>
required

RFC 3339 last-update timestamp.