Machine-readable description of the simulator for AI agents and onboarding tooling
1 of 1 operations are conformant: apis.io called them with no credentials and the responses matched this contract. Checked 2026-11-12. how this works · status file
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/cloudworldmodel-ai:cloudworldmodel-ai-discovery-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Cloudworldmodel Ai Discovery API
version: 1.0.0
contact:
name: Cloud World Model API Support
url: https://www.cloudworldmodel.ai
email: api@cloudworldmodel.ai
license:
name: MIT
url: https://opensource.org/licenses/MIT
description: 'Operations tagged Discovery across 2 of this provider''s published API definitions: cloudworldmodel-ai-openapi.json, cloudworldmodel-ai-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.cloudworldmodel.ai/api
description: Production
- url: http://localhost:5000/api
description: Local development
security: []
tags:
- name: Discovery
description: Machine-readable description of the simulator for AI agents and onboarding tooling
paths:
/description:
x-stability: experimental
get:
tags:
- Discovery
summary: Get simulator description
description: 'Returns a structured JSON document describing the Cloud World Model simulator —
its purpose, core concepts, workflow, capabilities, quick-start call sequence,
authentication requirements, entry points, intended use cases, and a pointer
to the OpenAPI spec. Intended to be consumed by AI agents before calling any
other endpoint so they can reason about available functionality.'
operationId: getDescription
security: []
responses:
'200':
description: Simulator description document
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: Cloud World Model Simulator
version:
type: string
example: 1.0.0
purpose:
type: string
description: High-level description of what the simulator does
core_concepts:
type: object
description: Key/value map of domain term definitions
additionalProperties:
type: string
workflow:
type: array
description: Ordered list of steps describing the typical usage flow
items:
type: string
capabilities:
type: array
description: Feature areas exposed by the simulator
items:
type: object
properties:
id:
type: string
example: simulations
name:
type: string
example: Simulations
description:
type: string
quick_start:
type: array
description: Step-by-step quick-start call sequence
items:
type: object
properties:
step:
type: integer
example: 1
label:
type: string
example: Create a simulation
method:
type: string
example: POST
path:
type: string
example: /api/simulations
description:
type: string
authentication:
type: object
properties:
type:
type: string
example: Bearer token (API key)
required_for:
type: array
items:
type: string
notes:
type: string
entry_points:
type: object
description: Named map of core interaction entry points
additionalProperties:
type: object
properties:
method:
type: string
example: POST
path:
type: string
example: /api/simulations
intended_use_cases:
type: array
items:
type: string
openapi_spec_url:
type: string
example: /api-docs
servers:
- url: https://www.cloudworldmodel.ai/api
description: Production
- url: http://localhost:5000/api
description: Local development
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: API Key or Wallet Session JWT
description: 'API key or wallet-session JWT authentication using Bearer tokens in the Authorization header.
**How to authenticate:**
1. Create an API key using POST /api/keys
2. Include the key in the Authorization header: `Bearer cwm_live_<your_key>`
3. All RL environment endpoints require authentication
**Rate Limits:**
- Default: 1000 requests/hour per key
- Configurable per key
- Returns 429 when exceeded
'
UiSessionCookie:
type: apiKey
in: cookie
name: cwm_ui_session
description: 'HttpOnly browser-workspace session cookie issued by
`POST /api/ui/simulations`. It authorizes UI mutations for simulations
owned by that browser workspace.
'
x402:
type: apiKey
in: header
name: X-PAYMENT
description: "x402 v2 Base micropayment option. Select the Base entry from\n`GET /api/billing/x402/config` `paymentOptions`, then send its signed USDC\nmicro-payment in the `X-PAYMENT` header to get full access to the metered\nendpoint in a single round-trip — no account, no API key, no sign-up required.\n\n**402 → pay → retry loop:**\n1. Call the endpoint without an `X-PAYMENT` header.\n2. Receive a `402 Payment Required` response. The body is a\n standard JSON `PaymentRequired` object. The same payload is also\n echoed as a base64-encoded string in the `PAYMENT-REQUIRED`\n response header for clients that cannot access the body.\n3. Decode the `PaymentRequired` body (or the `PAYMENT-REQUIRED`\n header) to read the exact `payTo` wallet,\n USDC amount, network, and facilitator URL.\n4. Construct and sign the payment with your x402 client library.\n5. Retry the Base request with the `X-PAYMENT` header — the server\n verifies via `https://facilitator.payai.network` and responds `200`.\n\n**Optional Solana:** When `paymentOptions` advertises a Solana entry, callers\nmay instead select it and use `PAYMENT-SIGNATURE`. Solana is an additional\noption; use `X-PAYMENT` for the Base option shown by this security scheme.\n\n**Discovery:** `GET /api/billing/x402/config` returns the live `payTo`\naddress, canonical `paymentOptions`, per-call-type USDC amounts, facilitator\nURL, and the credits-per-USDC conversion rate. Always fetch this before\nhardcoding any amounts or a payment header.\n\n**Price range:** $0.0030 per 3-credit call — $0.0050 per 5-credit\ncall (see `x-x402-price-usdc` on each\noperation for the exact amount).\n\n**Facilitator:** `https://facilitator.payai.network` (PayAI-operated,\nverifies the advertised Base and optional Solana options).\n"
x402Solana:
type: apiKey
in: header
name: PAYMENT-SIGNATURE
description: 'Optional x402 v2 Solana payment alternative. Use this security option only
when `GET /api/billing/x402/config` `paymentOptions` advertises a Solana
network, then send its signed Solana USDC payment payload in the
`PAYMENT-SIGNATURE` header. Include the option''s `feePayer` detail when
constructing the transaction.
For the primary Base payment option, select the `x402` security option
instead and send its signed payment payload in the `X-PAYMENT` header.
'
x-refined-from:
- cloudworldmodel-ai-openapi.json
- cloudworldmodel-ai-openapi.yml