Value API
Predict state values
Evaluate one or more state inputs with the installed value model or a candidate, and bind evaluation to the expected model identity when required.
Predict state values
Predict values for 1 to 256 inputs using the installed Adapt-1 value model or its candidate. Set
Read
The example’s
model_source explicitly when comparing models and supply the expected model hash for a bound evaluation. See prediction contracts for representation and counterpart-field notes.
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 asAuthorization: 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:ValuePredictRequest.
Fields outside this object’s declared properties are rejected by the schema.
ValueInput
Schema:ValueInput.
Fields outside this object’s declared properties are rejected by the schema.
Select the model you intend to evaluate
Readvalue/state after the relevant fit has completed, then bind the model explicitly:
Use the same encoded inputs when comparing the two models. If a model changes, preserve the response and reconcile state before repeating the comparison. Do not replace the expected hash and reuse an earlier model’s results as if they belonged to the replacement.
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.
Read the prediction response
This shortened response example shows the fields used to read predictions and verify model identity. Prediction values are rounded, model and dataset hashes are placeholders, and Domain/session fields and the run-specific model version are omitted. Confirm the response shape for your deployment before using it.Prediction response fields
predictions as a numeric array in input order. Keep your ordered input identifiers locally. Before consuming the array, check the model identity and require one finite numeric prediction for every submitted input. A missing or malformed result must not become a default score.
Validate a prediction batch
frozen: true describes the evaluator state shown; it is not a prerequisite for every prediction request. Inspect frozen and learning_updates when checking an evaluation boundary. Use evaluator.model_sha256 to identify the function’s artifact, then compare values on fixed inputs to determine whether its behavior changed.
For a new deployment, retain a response from a small known input batch and verify the shape and input/result alignment before relying on batch parsing. The Python workflow client shows request construction, job polling, and prediction checks together.