API reference · CAIN Impact

Simulate Whatif

POST /fabric/impact/simulate

Last reviewed 2026-10-02

POST /fabric/impact/simulate

What-if counterfactual simulation.

Operates against actual CAIN graph.

Parameters

Name	In	Type	Meaning
`tenant` required	query	string

Request body

ImpactSimulateRequest (required)

Field	Type	Meaning
`scenario` required	string
`entity` required	string
`entity_type` required	string
`parameters`	object or null

Responses

Status	Meaning	Body
`200`	Successful Response	JSON
`422`	Validation Error	`HTTPValidationError`
`401`	No key, or a key that is not valid	JSON `detail`
`429`	Rate limit for your plan reached; retry after the Retry-After seconds	JSON `detail`

Try it

Your API key X-API-Key Remember the key in this tab onlytenant queryRequest body application/json

This call changes data in the account the key belongs to.

The request goes from your browser straight to this site. Your key is not stored unless you tick the box, and then only in this tab's session storage.

Code

curl -sS -X POST 'https://cainstudio.online/fabric/impact/simulate?tenant=tenant' \
  -H "X-API-Key: $CAIN_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"scenario": "scenario", "entity": "entity", "entity_type": "entity-type"}'

import json, os, urllib.request

req = urllib.request.Request('https://cainstudio.online/fabric/impact/simulate?tenant=tenant', method='POST',
    headers={"X-API-Key": os.environ["CAIN_API_KEY"], "Content-Type": "application/json"},
    data=json.dumps({
      "scenario": "scenario",
      "entity": "entity",
      "entity_type": "entity-type"
    }).encode())
with urllib.request.urlopen(req, timeout=60) as r:
    print(r.status, json.load(r))

const res = await fetch("https://cainstudio.online/fabric/impact/simulate?tenant=tenant", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.CAIN_API_KEY!,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "scenario": "scenario",
    "entity": "entity",
    "entity_type": "entity-type"
  }),
});
console.log(res.status, await res.json());

Schemas used

HTTPValidationError · ImpactSimulateRequest · ValidationError

← Get Incident Trajectories · all 16 CAIN Impact calls · Status →

Try CAIN-42 on your own agents

Create a free account and every new account starts with a 7-day trial of the full platform. Or try the sandbox first, with no account at all.

Create a free account → · Try the sandbox · See the whole ecosystem