Main API entry points are documented here, but the lower level implementation details are not always that well documented. If the documentation is insufficient, it is possible to view the source code by clicking [source] link in the documentation. In case viewing the source is not helpful either, questions may be sent to the robotframework-users mailing list.
Command line entry points are implemented as Python modules and they also provide programmatic APIs. Following entry points exist:
The Robot Framework Jar distribution contains also a Java API, in the form of the org.robotframework.RobotFramework class.
robot.api package exposes the public APIs of Robot Framework.
Unless stated otherwise, the APIs exposed in this package are considered stable, and thus safe to use when building external tools on top of Robot Framework.
Currently exposed APIs are:
All of the above names can be imported like:
from robot.api import ApiName
See documentations of the individual APIs for more details.
APIs related to the command line entry points are exposed directly via the robot root package.
All robot packages are listed below. Typically you should not need to import anything from them directly, but the above public APIs may return objects implemented in them.