Quickstart · Runtime API
Your first governed PLEXA connection
Verify a Runtime endpoint and read robot state before moving on to command or streaming workflows.
Before you begin
Use a Runtime endpoint, not the portal API
You need the base URL of a local PLEXA Runtime or development simulator. The horstos.com /api/v1 routes serve the web platform and are deliberately separate from robot control.
- 01
Set the Runtime base URL
Use the endpoint supplied by your development environment.
export PLEXA_RUNTIME_URL="http://127.0.0.1:8080" - 02
Verify the contract
The hello request confirms that the high-level Runtime surface is reachable.
curl "$PLEXA_RUNTIME_URL/api/runtime/hello?name=developer" - 03
Read the current pose
Start with feedback. Command examples require an explicitly configured development environment.
curl "$PLEXA_RUNTIME_URL/api/runtime/status/pose" - 04
Choose the next integration path
Continue with the protocol reference, ROS 2 guidance, or the simulation workflow.
A successful network request is not permission to move a robot. Commands remain subject to environment configuration, Runtime validation, motion control, and robot safety.