Create

Fetch an RL training environment

Retrieve the current state and configuration of an RL environment

get/rl/environments/{environmentId}

Request

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

Path parameters

environmentIdstring uuid required

Response

Environment details

idstring uuid
simulationIdstring uuid
currentStepinteger

Current step number in episode

totalRewardnumber

Cumulative reward so far

isActiveboolean

Whether episode is still running

lastSimTimeHumanstring

Human-readable simulated elapsed time as of the last step or reset (e.g. "1h 30m"). Absent before the first step.

createdAtstring date-time
updatedAtstring date-time
webhookDeliveryStatus'pending' | 'delivered' | 'failed'

Webhook delivery status (for episode completion)

webhookDeliveryAttemptsinteger

Number of webhook delivery attempts made

webhookDeliveryErrorstring

Error message if webhook delivery failed

webhookDeliveredAtstring date-time

Timestamp when webhook was successfully delivered

idleExpiresAtstring date-time

ISO 8601 timestamp at which this environment will be automatically expired due to inactivity. Computed as lastActivityAt (or createdAt if no step or reset has been called yet) plus the 2-hour idle TTL. Agents can use this value to schedule keep-alive calls (POST /rl/environments/{environmentId}/step or POST /rl/environments/{environmentId}/reset) before expiry.

Example response

{
  "episodeConfig": {
    "maxSteps": 300,
    "targetTrafficPattern": "ramp",
    "initialTraffic": 5000,
    "targetSLA": {
      "maxLatencyP95": 200,
      "maxErrorRate": 1
    },
    "costBudgetPerHour": 5,
    "tick_seconds": 60,
    "unmodeled_cost_penalty_per_dimension": 0.1,
    "evalCostOverrides": {
      "egress": 0.5,
      "cross_az_traffic": 0.3
    }
  },
  "currentStep": 42,
  "totalReward": 12.45,
  "isActive": true,
  "lastSimTimeHuman": "1h 30m",
  "webhookDeliveryStatus": "delivered",
  "webhookDeliveryAttempts": 1,
  "idleExpiresAt": "2024-01-15T14:00:00.000Z",
  "rewardWeights": {
    "cost": 0.4,
    "resilience": 0.2,
    "latency": 0.2,
    "performance": 0.1,
    "stability": 0.1
  }
}

Changes

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