<!-- DOCS_PROMISE_REPLAY:promise-replay -->
# Promise replay

Canonical HTML: https://spoolis.com/docs/promise-replay. This page is also available in machine-readable Markdown.

Replay submitted history under candidate vendor terms and inspect hypothetical results.

## What it does

Promise replay applies terms the vendor chooses to submitted historical units and corrections. Every remedy is hypothetical, and the result does not predict future results.

## Request and response

Send JSON to POST /api/v1/promise-replay with a full-scope key. as_of is required and is the only clock used. The response contains run_id, report, and markdown.

## Privacy and links

Submitted history is processed in memory and is not stored or logged. [API reference](/docs/api), [OpenAPI](/openapi.json).
