Understand

Generate a natural-language explanation of simulation behaviour

Uses GPT-5 to generate a natural-language explanation of what is currently happening in the simulation: why latency is high, why autoscaling is or isn't triggering, what the dominant cost drivers are, etc.

Set beginnerMode: true to receive a simplified, jargon-free explanation suitable for cloud newcomers.

Authentication: Requires an API key (write scope) or an x402 micro-payment (3 credits — $0.0030 USDC on Base). Pass Authorization: Bearer <key> for API key access, or include a signed x402 payment header (no account required). Use GET /api/billing/x402/config to discover the live price.

post/simulations/{simulationId}/explain

Request

  • Base URL: https://www.cloudworldmodel.ai/api
  • URL: https://www.cloudworldmodel.ai/api/simulations/{simulationId}/explain
  • Auth: one of:
    • HTTP bearer
    • API key in header X-PAYMENT
    • API key in header PAYMENT-SIGNATURE

Path parameters

simulationIdstring required

Simulation UUID

Request body

beginnerModeboolean

Return a simplified, jargon-free explanation

Response

AI explanation

explanationstring

Natural-language explanation of simulation behaviour

Example response

{
  "explanation": "Your simulation is experiencing high CPU utilization (82%) because the traffic load of 8 000 RPS exceeds the capacity of the current 3-node cluster. The autoscaler has not yet triggered because CPU has not been above the 75% threshold for the required 2-step cooldown window."
}

Changes

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