Runs

Promote Run

Make a model run's inputs the script's defaults.

Queues a default run (source promote). For every model, a successful candidate installs its INPUTS defaults, a revision build, membership and depths. Verified results publish in the same transaction; superseded results retain the prior allocations and queue a fresh run. Execution failures preserve prior defaults and results. Required child models settle before execution. Successful live runs cascade to dependents. Answers 202 with that run, or 200 with it finished when wait=true. Models only (409 not_promotable for other kinds); 409 when the run is not complete, the script changed beyond INPUTS defaults, the run already uses the defaults, or a default run is in flight. A run from an earlier revision still promotes when the live script differs only in those default literals.

post/v1/runs/{run_id}/promote

Request

  • Base URL: https://api.ensemble.markets (the document declares no server; this is the origin it was published from)
  • URL: https://api.ensemble.markets/v1/runs/{run_id}/promote
  • Auth: HTTP bearer

Path parameters

run_idstring required

Run ID (run_... or legacy mr-/r-...). Use the returned ID; kind identifies the program type.

Query parameters

waitboolean

Block until the new default run finishes

Response

Completed inline (wait=true)

idstring required

Run ID (run_... or legacy mr-/r-...). Read kind for the program type.

kind'model' required
status'queued' | 'running' | 'complete' | 'failed' required
source'build' | 'manual' | 'scheduled' | 'cascade' | 'promote' required

build: the build's smoke run; manual: requested; scheduled: the nightly; cascade: a member changed; promote: after a promote

labelstring nullable
inputsobject required
is_defaultboolean required

Inputs equal the script's declared defaults

intent'test' | 'refresh' nullable
result_availableboolean

Whether the full result is retained and readable

revision_idstring nullable
result_contextobject nullable

Execution-time strategy, input schema, display window and data provenance. Unknown legacy values are omitted, never borrowed from the current model.

is_publicboolean
liveboolean

This run's result is what the program serves

data_as_ofstring nullable
script_hashstring nullable

SHA-256 of the script that ran; resolves to a build via getBuild

summaryobject nullable

Headline figures, kept even when the full result is pruned

estimate_centsinteger nullable

On the response that queued this run: what it holds against the balance, in cents, until usage replaces it. Null on other reads.

errorstring nullable
duration_msinteger nullable
created_atstring date-time required
started_atstring date-time nullable
completed_atstring date-time nullable
resultobject nullable

With include=result: the model backtest history, including dates, returns, positions, targets and metadata.

is_ownerboolean

True when the caller owns this run

Changes

No recorded changes to this operation across all 1 revision of this API.