Skip to content

Rerun Scenario

POST
/api/v1/replay/scenarios/{scenario_id}/rerun
curl --request POST \
--url https://api.ultimateteam.ai/api/v1/replay/scenarios/example/rerun \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--data '{ "horizon_months": 1 }'

Re-run an existing scenario with a different horizon.

scenario_id
required
Scenario Id
string
Media typeapplication/json
RerunRequest
object
horizon_months
required
Horizon Months
integer
>= 1 <= 12
Examplegenerated
{
"horizon_months": 1
}

Successful Response

Media typeapplication/json
Response Rerun Scenario Api V1 Replay Scenarios Scenario Id Rerun Post
object
key
additional properties
any
Examplegenerated
{}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}