Introduction to RoadAI API

The RoadAI API is mostly used to integrate RoadAI data into other road asset management systems or to implement your own RoadAI client application.

The RoadAI API is documented at swagger.vionice.io. It contains a list of API endpoints and their descriptions, and example of requests and responses for each endpoint.

A Python library to access the RoadAI API is available at https://gitlab.com/vionice/roadai-python.

The following Python scripts are the most commonly used.

Name	Description	URL
Download videos	Download videos and their metadata (such as recording user, location, timestamp, and similar)	https://gitlab.com/vionice/roadai-python/-/blob/master/examples/download-videos.py?ref_type=heads
Download data overlay data	Download data overlay data (such as the road surface condition score for a set of videos)	https://gitlab.com/vionice/roadai-python/-/blob/master/examples/download_pavement_condition_index.py?ref_type=heads
Generate data reports	Generate any RoadAI data report	https://gitlab.com/vionice/roadai-python/-/blob/master/examples/generate_data_report.py?ref_type=heads
Fetch point object data	Fetch point object data (such as traffic signs and surface markings)	https://gitlab.com/vionice/roadai-python/-/blob/master/examples/fetch_point_objects.py?ref_type=heads