Skip to main content
Promote a value candidate
Promote the candidate identified by expected_model_sha256. Include the expected incumbent identity when adopting after a paired comparison. Value promotion explains the observed confidence gate, HTTP 409 rejection, and the difference between fitting, checkpoint selection, and installation. The request tables below describe schema version 5. A default marked “Not declared” is absent from that schema; it does not mean null. Check /version at the API host root and confirm compatibility with your deployment.

Path, headers, and query

Send the hosted API key as Authorization: Bearer <ADAPT1_API_KEY>. The authenticated identity determines ownership; follow HTTP and contracts for the session placeholder. X-Neuroadapt-Session-Id is a compatibility header in schema version 5. It does not replace the hosted bearer identity.

JSON body contract

Content type: application/json. The HTTP request body is required. The following table describes its fields; linked schema names lead to the complete nested definitions on this page. When an array type also permits null, that alternative applies to the entire field, not to individual array items.

Request body

Schema: ValuePromoteRequest. Fields outside this object’s declared properties are rejected by the schema.

ValueCanary

Schema: ValueCanary. Fields outside this object’s declared properties are rejected by the schema.

CanaryCase

Schema: CanaryCase. Fields outside this object’s declared properties are rejected by the schema.

Responses

The validation error shape has an optional detail array. Each validation entry requires loc (an array of strings or integers), msg (string), and type (string); it can also include ctx (object) and input (any JSON value). Operational refusals can have their own error details. Observed promotion can return HTTP 409 when the application canary does not demonstrate sufficient improvement. Preserve its reason and check the installed identity; see promotion decisions.