Skip to main content
POST
Publish an engine version

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.

Path Parameters

engine_slug
string
required

Engine identifier slug (e.g. default).

Body

application/json
changelog
string

Human-readable summary recorded on the version row.

version
string

Accepted for compatibility; the platform mints the version.

is_breaking_from_previous_major
boolean

Accepted for compatibility; the schema comparator decides.

Response

The released version: freshly minted, or the existing latest release (already_released: true) when the saved config is already released.

version
string
required

Two-tier major.minor identifier (e.g. 1.0, 1.3, 2.0).

Pattern: ^\d+\.\d+$
released_at
string<date-time>
required

When the version row was created.

changelog
string
required

Operator-supplied human-readable summary of what changed.

is_breaking_from_previous_major
boolean
required

True only when this is a *.0 row AND a prior major ((major-1).*) also exists for the same engine. The first-ever release of an engine reports false.

gate_verified
boolean
required

Whether the release passed the cold-start trust gate.

request_schema_hash
string

SHA-256 of the exact canonical released request schema bytes.

Pattern: ^[0-9a-f]{64}$
response_schema_hash
string

SHA-256 of the exact canonical released response schema bytes.

Pattern: ^[0-9a-f]{64}$
published_by
string

Actor recorded at publish: a dashboard user ID for dashboard publishes, api_key:<id> for API publishes. Omitted on backfilled rows with no recorded actor.

cold_start_eval_set_id
string

Cold-start evaluation set used by a gate-verified release.

already_released
boolean

Present and true on the idempotent no-op.

bump
enum<string>

Comparator verdict for a fresh publish.

Available options:
major,
minor
reasons
string[]

Breaking-change reasons when bump is major.