RAIDR/API Reference/Planning

Plan relays

posthttp://127.0.0.1:8787/api/v1/relay/plan

Places relays along the geodesic to meet a target data rate. The planner walks from the transmitter toward the receiver, placing each relay at the farthest tested point that still closes for the target rate, until the receiver is in reach or max_hops is exceeded.

Returns the hop chain, per-segment link results, the end-to-end bottleneck rate, and the relay radio and pointing configuration to commit matching nodes.

Request

application/json

This endpoint expects an object.

tx_node_idstring <uuid>Required
rx_node_idstring <uuid>Required
target_data_rate_bpsintegerRequired

Rate every segment must sustain.

relay_height_agl_mnumberOptional

Antenna height for placed relays.

max_hopsintegerOptional

Upper bound on the chain length.

Response

200 · application/json

Relay plan. Returns an object.

Errors

400
Problem

Malformed request.

404
Problem

Resource not found.