canonical: https://jentic.com/apis/cloudrf.com/cloudrf # Cloud-RF API Jentic publishes the only available OpenAPI specification for Cloud-RF API, keeping it validated and agent-ready. The Cloud-RF API computes radio frequency coverage, link budgets, and interference for any radio, antenna, and terrain on Earth. It exposes endpoints to model point-to-point paths, point-to-multipoint heatmaps, multi-site coverage meshes, and best-server selection across networks, plus archive management to list, export, and delete past calculations. Authentication is via a key header, and outputs include heatmap tiles, GIS exports, and structured link budget data. ## For AI agents Run RF propagation, coverage, and interference calculations for radio networks anywhere on Earth - point-to-point paths, point-to-multipoint heatmaps, and multi-site mesh coverage. ## Scope Does not handle radio hardware control, spectrum licensing, or live signal monitoring - use for offline RF propagation, coverage, and link budget calculations only. ## Capabilities - Compute point-to-point path profile and link budget between a transmitter and receiver - Generate point-to-multipoint heatmaps for area coverage analysis - Merge multiple transmitter sites into a single coverage mesh layer - Find the best server for a given location across overlapping networks - Detect interference between overlapping transmitter coverage areas - Export past calculations as GIS files and manage the calculation archive ## Use cases ### Wireless Network Planning and Coverage Mapping Wireless ISPs, mobile operators, and private LTE deployments use the Cloud-RF API to model coverage before installing hardware. The /area endpoint produces a point-to-multipoint heatmap from a single transmitter, and /mesh combines several sites into a single coverage layer. Inputs include transmitter coordinates, antenna pattern, frequency, and power, and the response includes a heatmap image plus structured link budget data that engineers can review without running a separate propagation tool. Example prompt: Run /area for a 2.4 GHz transmitter at lat 51.5, lon -0.12, antenna height 30m, EIRP 36 dBm and return the coverage heatmap URL ### Point-to-Point Link Feasibility Studies Engineers planning a microwave or unlicensed point-to-point backhaul need to verify line-of-sight and link budget before committing to hardware. The /path endpoint runs a full path profile from transmitter to receiver including terrain, clutter, and Fresnel zone obstructions, and returns whether the link closes at the chosen frequency, modulation, and antenna gain. Results are deterministic and can be archived for later export through /archive/export. Example prompt: Run /path between Tx at lat 40.7128, lon -74.0060 height 50m and Rx at lat 40.7589, lon -73.9851 height 30m at 5.8 GHz and report whether the link closes ### Best-Server and Interference Analysis for Multi-Site Networks Operators running networks with overlapping coverage need to know which transmitter should serve a given receiver and where coverage from neighbouring sites causes interference. /network returns the best server for a single location, /interference highlights overlap zones across the whole network, and /mesh consolidates everything into one layer. This replaces manual GIS overlays and makes capacity decisions defensible with concrete link budget numbers. Example prompt: Call /network for a receiver at lat 52.5, lon 13.4 and identify which of the 5 transmitters in the network provides the strongest signal ### Agent-Driven RF Propagation via Jentic AI agents working on telecoms deployments, drone communications, or emergency response can call the Cloud-RF API through Jentic to evaluate radio coverage on demand. The agent expresses an intent like 'calculate point-to-point link budget', Jentic loads the matching Cloud-RF operation, supplies the API key from the vault, and returns structured results the agent can use to recommend antenna placement or frequency choice without parsing GIS file formats. Example prompt: Through Jentic, search for 'calculate radio link budget', load the cloudrf.com /path operation, and execute it for two specified coordinates at 900 MHz ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | /path | Point-to-point path profile analysis | | POST | /area | Create a point-to-multipoint heatmap | | POST | /points | Point-to-multipoint path profile across many transmitters | | GET | /network | Find the best server for a location | | GET | /interference | Find the best server across overlapping coverage | | GET | /mesh | Merge multiple site coverages into one layer | | GET | /archive/list | List past calculations from your archive | | GET | /archive/export | Export a calculation as a GIS file | ## Key resources - **Path** — Point-to-point path profile and link budget calculations - **Area** — Point-to-multipoint coverage heatmaps from a single transmitter - **Network** — Best-server selection and multi-site coverage operations - **Interference** — Overlap detection between coverages of competing transmitters - **Mesh** — Merged super-layer combining multiple site coverages - **Archive** — List, export, and delete previously run calculations - **Clutter** — Upload custom GeoJSON clutter data to refine propagation modelling ## Why Jentic - **Setup:** Wiring Cloud-RF by hand means learning its key-header API auth, POSTing propagation jobs to api.cloudrf.com, and handling retries and timeouts on the longer calculations yourself. Through Jentic you install once, import the Cloud-RF API from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** Cloud-RF carries no resource id in the URL path, so scope the agent to the operations it needs, such as running a point-to-point path calculation or an area coverage calculation. You choose that set, so heavier operations like /area or /mesh are not included unless you add them. - **Credential handling:** Your Cloud-RF key is stored once, encrypted, by your own Jentic One instance and injected into the key header at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'calculate a radio link budget' or 'generate a coverage heatmap', and Jentic returns the matching Cloud-RF operation with its input schema so the agent calls the right endpoint without reading the Cloud-RF documentation. ## Related APIs - **HERE Maps API** — HERE Maps provides geocoding, routing, and base maps that pair with Cloud-RF coverage outputs - **Google APIs** — Google APIs provide geocoding and Earth imagery that complement Cloud-RF terrain-based propagation results - **Cloudflare API** — Cloudflare provides edge delivery for the heatmap tiles and exports produced by Cloud-RF calculations ## FAQ ### Why is there no official OpenAPI spec for Cloud-RF API? Cloud-RF does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Cloud-RF API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the Cloud-RF API use? The Cloud-RF API uses an apiKey scheme with the key passed in the HTTP header named key. Through Jentic the API2.0 key is stored encrypted in the vault and injected at execution time, so it never appears in the agent context. ### Can I run point-to-point link budget calculations with the Cloud-RF API? Yes. The /path endpoint takes transmitter and receiver coordinates, antenna heights, frequency, and EIRP, then returns a full path profile including terrain and clutter losses plus a link budget figure indicating whether the link closes. ### How do I generate a coverage heatmap with the Cloud-RF API? Call POST /area with the transmitter coordinates, antenna pattern, frequency, and power. The response includes a heatmap tile reference plus structured coverage data, and the calculation is also added to the archive so it can later be exported via /archive/export. ### What are the rate limits for the Cloud-RF API? The OpenAPI specification does not declare explicit rate limit headers or a 429 response. Cloud-RF applies plan-based limits documented on cloudrf.com, and high-volume callers should batch coverage runs and reuse archived results where possible. Through Jentic, retries and backoff are handled by the SDK. ### How do I run a coverage calculation with the Cloud-RF API through Jentic? Install the SDK with pip install jentic, search for 'calculate radio coverage', load the cloudrf.com /area operation, and execute it with the transmitter parameters. Jentic supplies the key header automatically and returns the structured response from /area, including the heatmap URL. ### Can I upload my own clutter data to improve propagation accuracy? Yes. POST /clutter/add accepts custom clutter as GeoJSON, which is then used in subsequent /path, /area, and /mesh calculations. This is useful where the default global clutter dataset is out of date for a specific site. ### Can I limit what my agent is allowed to do with the Cloud-RF API? Yes. Because you run Jentic One yourself, your own rules decide which Cloud-RF operations and credentials the agent may use, and the Cloud-RF API carries no resource id in the URL path, so you scope purely by operation. You can allow just the calls the agent needs, such as running a point-to-point path calculation with /path or an area coverage heatmap with /area, and leave everything else off. Heavier operations like /mesh or archive management such as /archive/export and delete stay unavailable unless you explicitly add them to the allowed set.