Skip to main content
The Adapt-1 value API manages observations, fitting, prediction, candidates, and the retained value model for a Domain. All eight operations use POST /api/v1/domains/{domain_id}/value/ followed by the operation name. Use the learning workflow for their execution order and the endpoint pages below for the documented request fields, types, defaults, and limits.

Authentication and schema source

Use the authenticated client and hosted identity rules in HTTP and contracts. The value request schemas require a nonempty session_id. On the hosted proxy, use "ignored" as the compatibility placeholder; the bearer token determines the effective identity. Read GET /version at the API host root and confirm compatibility with your deployment. The manual value and planning request tables describe schema version 5. Response-field notes record observed response shapes; validate the fields used by your integration against the deployment’s responses. Schema version 5 defines request fields and success status codes but leaves success response bodies untyped. The guides document observed response fields; validate the fields your application consumes. The train success status is 202; the other value operations declare 200.

Routes

Configure

config.relation and config.policy are required nonempty strings. Use the identifiers for your application’s value relation and policy. representation is projected by default or object_graph. max_samples defaults to 20000 and accepts integers from 4 to 250000.
Configure request
The identifiers above are application examples. Preserve your chosen value scale and perspective across fitting, prediction, and planning. Inspect the returned configuration and status: configured before uploading observations.

Observe and train

value/observe accepts at most 50 observation rows per request and at most 50 application-outcome rows. Each observation requires record_id, episode_id, and nonnegative step. The observed admission rule requires exactly one of target, outcome, or continuation. See value observations for complete request construction, continuations, comparison groups, and exact-replay behavior. value/train requires session_id and request_id. Put warm_start inside options; put warm_start_source, expected_initial_model_sha256, observation_ids, and install at the request level. Both options.warm_start and install default to true. Make these choices explicit in integration code. Use install: false when fitting a candidate for a separate application comparison. HTTP 202 acknowledges the training request; inspect value/state and its training report for completion and adoption. See value training.

Predict

value/predict accepts between 1 and 256 inputs. Set model_source to installed (default) or candidate; expected_model_sha256 can bind the intended model. An input can carry objects, relations, conditions, context, and policy_features, plus include_positions and include_moments.
Prediction request
This input illustrates an application-defined numeric feature. Use the same representation and feature meanings as the fitted model. For a model-bound evaluation, add the actual expected_model_sha256 from state before submitting the request. The schema also accepts optional counterparts containing 1 to 256 value inputs and complementary_total, default 1. Confirm the pairing and transformation semantics with your deployment before enabling this optional path.

Promote and freeze

value/promote requires the expected candidate SHA-256. Supply the incumbent hash as well when performing a paired comparison so the call remains bound to the evaluated model pair. The promotion guide covers the canary and observed rejection rules. value/freeze requires session_id and a 64-character expected_model_sha256. The schema has no Boolean freeze flag or unfreeze field. Bind the model you intend to evaluate, then inspect frozen and the model identity in returned state. Resume learning through the deployment’s supported controls.

Inspect and reset

Both value/state and value/reset accept the following body:
State or reset request body
The routes perform different operations despite sharing a request schema. Use value/state for inspection and uncertain-write reconciliation. Observed responses expose config, sample_count, dataset_version, dataset_sha256, model, candidate, training, and frozen. Use value/reset for an intended value-state reset. Verify your deployment’s postconditions for retained records and configuration before incorporating reset into a workflow. This route has its own behavior, separate from Domain /clear and /policy/reset.

Handle refusals and retries

The observed value workflow can reject invalid supervision, missing fitted references, missing evidence or groups in a partition, excessive continuation work, conflicting record IDs, and unsuccessful promotion canaries. Preserve the response reason and the relevant model and dataset identities before changing a request. Observation record_id replay and feedback ref replay have different behavior. Use request_id for correlation and SHA guards to bind model identity. Apply the operation-specific retry and idempotency rules.