Skip to content
UltimateTeam.ai Docs

Create Scenario

POST
/api/v1/replay/scenarios
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/replay/scenarios \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "branches": [ { "alternative_action": "example", "label": "example" } ], "decision_id": "example", "horizon_months": 6, "name": "example", "note": "example" }'

Create and run a counterfactual strategy replay.

Validates 2-4 branches (SR-02) and horizon 1-12 months (SR-08). Returns 422 if the requested horizon exceeds the decision’s age (data availability gate).

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CreateReplayRequest
object
branches
required
Branches
Array<object>
>= 2 items <= 4 items
BranchInput
object
alternative_action
required
Alternative Action
string
label
required
Label
string
decision_id
required
Decision Id
string
horizon_months
Horizon Months
integer
default: 6 >= 1 <= 12
name
Any of:
string
note
Any of:
string

Responses

Section titled “ Responses ”

201

Section titled “201”

Successful Response

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

422

Section titled “422”

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"
    }
  ]
}