Authentication
Learn how to make requests using the Reforge API.
Authentication and Permissions
Reforge access is scoped per robot. Depending on how your robot is onboarded, you will use either:
robot_idonly, or- both
robot_idandapi_key.
If your robot was registered by an OEM
If you selected Use a registered robot in the Reforge app, your OEM integration handles API authentication in their controller flow. You typically only need to get and store your robot_id on the robot during setup:
- Register from the OEM-provided link.
- Get a Reforge
robot_id. - Enter that
robot_idin the OEM robot setup UI/controller.
If you are registering your own robot
If you selected Register a new robot, you need both credentials:
robot_idfor robot identity.api_keyfrom app.reforgerobotics.com/api-keys for API authentication.
Use both in the calibration/identification command from Quickstart:
bashpython3 -m robot.run calibrate <robot_ip> --local_ip <local_ip> --sdk_token <robot_sdk_token> --robot_id <reforge_robot_id> --identify <reforge_api_key>
In this command:
--robot_idis your Reforge robot ID.--identifyis your Reforge API key.