Ouster Gemini Detect API

Perception HTTPS API specification

default

GET /perception/api/v1/

Root api endpoint

Status Codes:
GET /

Root endpoint

Status Codes:
GET /perception/api/v1

Root endpoint

Status Codes:

Sensor Management

GET /perception/api/v1/sensor

Get list of Sensors

Get full list of sensors connected to perception pipeline

Status Codes:
DELETE /perception/api/v1/sensor

Clears all lidars

Removes all live and pcap sensors from perception pipelines and sources. Effectively puts system back into original state with respect to added sensors. Note this does not affect extrinsics, that should be cleared separately

Status Codes:
GET /perception/api/v1/sensor/{status}

Get list of active/inactive Sensors

Get list of sensors with given status ({active, inactive}) connected to perception pipeline.

Parameters:

  • status (string) –

Status Codes:
PUT /perception/api/v1/sensor/{hostname}

Add a sensor

Add sensor to perception server

Parameters:

  • hostname (string) –

Status Codes:
DELETE /perception/api/v1/sensor/{sensor_id}

Remove Sensor

Remove sensor by serial number

Parameters:

  • sensor_id (string) –

Status Codes:
PUT /perception/api/v1/pcap

Add PCAP and sensor metadata for replay

Adds a PCAP and the associated lidar sensor metadata to the perception server for replay

Status Codes:

Settings

GET /perception/api/v1/settings

Get all settings

Get all current settings

Status Codes:
POST /perception/api/v1/settings

Set all settings.

Set entirely new settings file

Status Codes:
PUT /perception/api/v1/set_profile/{profile}

Set the current profile

Set the current profile

Parameters:

  • profile (string) –

Status Codes:
GET /perception/api/v1/profile/{profile}

Get profile by name

Get profile by name

Parameters:

  • profile (string) –

Status Codes:
PUT /perception/api/v1/profile/{profile}

Add/Update settings profile

Add/Update settings profile

Parameters:

  • profile (string) –

Status Codes:
DELETE /perception/api/v1/profile/{profile}

Remove profile by name

Remove profile by name

Parameters:

  • profile (string) –

Status Codes:
GET /perception/api/v1/profiles

Get list of profiles

Get list of profiles

Status Codes:
PUT /perception/api/v1/restore_profile/{profile}

Restore profile to default values

Restore profile to default values

Parameters:

  • profile (string) –

Status Codes:

Registration

GET /perception/api/v1/extrinsics

Access all extrinsics data.

The REST endpoint/path used to get extrinsics data.

Status Codes:
PUT /perception/api/v1/extrinsics

Upload all extrinsics data.

The REST endpoint/path used to set all sensors extrinsic data.

Status Codes:
DELETE /perception/api/v1/extrinsics

Clear all extrinsics data.

The REST endpoint/path used to clear all sensors extrinsic data.

Status Codes:
GET /perception/api/v1/extrinsics/{sensor_id}

Access sensor extrinsics data.

The REST endpoint/path used to get extrinsics data for a given sensor_id

Parameters:

  • sensor_id (integer) –

Status Codes:
PUT /perception/api/v1/extrinsics/{sensor_id}

Upload sensor extrinsics data.

The REST endpoint/path used to set extrinsics for a given sensor_id.

Parameters:

  • sensor_id (integer) –

Status Codes:
DELETE /perception/api/v1/extrinsics/{sensor_id}

Remove sensor extrinsics data.

The REST endpoint/path used to remove extrinsics for a given sensor_id.

Parameters:

  • sensor_id (integer) –

Status Codes:
POST /perception/api/v1/extrinsics/icp

Run ICP algorithm on point clouds

Status Codes:

Execution

PUT /perception/api/v1/execution/reset

Stop perception application. Operating system will restart the application

Status Codes:
POST /perception/api/v1/execution/play

Play streaming of perception data

Status Codes:
POST /perception/api/v1/execution/pause

Pause perception data stream

Status Codes:
POST /perception/api/v1/execution/step

Step data stream

Step forward a single frame in the data stream.

Status Codes:
PUT /perception/api/v1/execution/start_recording/{filename}

Start recording PCAP of all connected sensors with given filename

Parameters:

  • filename (string) –

Status Codes:
GET /perception/api/v1/execution/stop_recording

Stop recording PCAP

Status Codes:
DELETE /perception/api/v1/execution/delete_recording/{filename}

Delete PCAP with given filename

Parameters:

  • filename (string) –

Status Codes:
GET /perception/api/v1/execution/list_recordings

Get list of of all recordings in a directory

Status Codes:

Point Zones

GET /perception/api/v1/point_zones

Get all zones

Get all zones

Status Codes:
PUT /perception/api/v1/point_zones

Add zones

Replace the current point zones

Status Codes:
PUT /perception/api/v1/point_zones/{point_zone_id}

Add zone

Add/update point zone with given point_zone_id

Parameters:

  • point_zone_id (integer) –

Status Codes:
DELETE /perception/api/v1/point_zones/{point_zone_id}

Remove zone

Remove zone with given point_zone_id

Parameters:

  • point_zone_id (integer) –

Status Codes:

Access

PUT /perception/api/v1/password

Set the login password for ouster user

Replace the current password for ouster user

Status Codes:

Diagnostics

GET /perception/api/v1/alerts

Get alert data

Get alert data from the server.

Status Codes:
GET /perception/api/v1/alerts/active

Get active alert data

Get active alert data from the server.

Status Codes:
GET /perception/api/v1/alerts/logged

Get logged alert data

Get logged alert data from the server.

Status Codes:
GET /perception/api/v1/telemetry

Get telemetry information

Get telemetry information from the server

Status Codes:
GET /perception/api/v1/configuration

Get configuration information

Get all the configuration files from the server

Status Codes:

Static

GET /perception/api/v1/about

Gets perception server’s static ‘about’ information

Get static system information from the server

Status Codes:

Lidar Hub HTTPS API specification

Diagnostics

GET /lidar-hub/api/v1/about

Get static information ‘about’ the Lidar Hub

Status Codes:
GET /lidar-hub/api/v1/diagnostics

Get System Diagnostics

Status Codes:
GET /lidar-hub/api/v1/system_health

Get System Health

Status Codes:
GET /lidar-hub/api/v1/telemetry

Get Lidar Hub ‘telemetry’ information

Status Codes:

Settings

GET /lidar-hub/api/v1/default_settings

Get application default values

Status Codes:
PUT /lidar-hub/api/v1/default_settings

Restore application settings to default values

Status Codes:
GET /lidar-hub/api/v1/settings

Get all application settings

Status Codes:
POST /lidar-hub/api/v1/settings

Set all application settings.

Status Codes:
GET /lidar-hub/api/v1/world

Get the World Geo-Coordinates

Status Codes:
PUT /lidar-hub/api/v1/world

Set the World Geo-Coordinates

Status Codes:

Cloud Storage

GET /lidar-hub/api/v1/cloud_storage

Get Cloud Storage Profiles

Status Codes:
POST /lidar-hub/api/v1/cloud_storage

Add/Update a Cloud Storage Profile

Status Codes:
PUT /lidar-hub/api/v1/cloud_storage

Set The Active Cloud Storage Profile

Query Parameters:

  • profile (string) – Cloud Storage Profile.

Status Codes:

Cloud Connectivity

POST /lidar-hub/api/v1/certificate

Save a Certificate

Query Parameters:

  • name (string) – Certificate Name

Status Codes:
GET /lidar-hub/api/v1/cloud_connectivity

Get Cloud Connectivity Profiles

Status Codes:
POST /lidar-hub/api/v1/cloud_connectivity

Add/Update a Cloud Connectivity Profile

Status Codes:
PUT /lidar-hub/api/v1/cloud_connectivity

Set The Active Cloud Connectivity Profile

Query Parameters:

  • profile (string) – Cloud Connectivity Profile.

Status Codes:
GET /lidar-hub/api/v1/streaming_connectivity

Get Streaming Connectivity Profiles

Status Codes:
POST /lidar-hub/api/v1/streaming_connectivity

Add/Update a Streaming Connectivity Profile

Status Codes:
PUT /lidar-hub/api/v1/streaming_connectivity

Set The Active Streaming Connectivity Profile

Query Parameters:

  • profile (string) – Streaming Connectivity Profile.

Status Codes:

Sensor Management

GET /lidar-hub/api/v1/background_cloud

Retrieves the background point cloud for all sensors

Query Parameters:

  • downsample_factor (number) – How much to downsample the background cloud (1 = no downsampling)

Status Codes:
GET /lidar-hub/api/v1/background_cloud/{sensor_id}

Retrieves the background point cloud for a single sensor

Parameters:

  • sensor_id (string) – Lidar Sensor ID (serial number)

Query Parameters:

  • downsample_factor (number) – How much to downsample the background cloud (1 = no downsampling)

Status Codes:

Event Zones

GET /lidar-hub/api/v1/event_zones

Get Event Zones

Status Codes:
GET /lidar-hub/api/v1/event_zones/active

Query Active Occupancy by ID, Classification and Dwell

Query Parameters:

  • ids (string) – Comma-delimited string of event zone IDs (default = 0: ALL)

  • classifications (string) – Comma-delimited string of Classifications (default = ALL)

  • min_dwell_secs (number) – Minimum dwell in seconds (default = 0.0)

Status Codes:
GET /lidar-hub/api/v1/event_zones/alerts

Get Active Alerts for All Event Zones

Status Codes:
GET /lidar-hub/api/v1/event_zones/realtime

Get Real-Time Occupancy of All Event Zones

Status Codes:
GET /lidar-hub/api/v1/event_zones/timeseries

Get Current Timeseries for All Event Zones (Note: timeseries is likely in progress)

Status Codes:

Execution

PUT /lidar-hub/api/v1/ota/force_software_check

Force immediate check for a pending software OTA request

Status Codes:
GET /lidar-hub/api/v1/pcap_recording/active

Get Active PCAP Recording(s)

Status Codes:
GET /lidar-hub/api/v1/pcap_recording/buffer_active

Get State of PCAP Ring Buffer

Status Codes:
POST /lidar-hub/api/v1/pcap_recording/start

Starts a PCAP Recording.

Status Codes:
POST /lidar-hub/api/v1/pcap_recording/start_buffer

Starts the PCAP Ring Buffer.

Query Parameters:

  • buffer_length_s (number) – Size of PCAP ring buffer in seconds. If not specified (default is 0), the ring buffer will be set to the size specified in the system settings.

Status Codes:
GET /lidar-hub/api/v1/pcap_recording/stop

Stops an active PCAP Recording.

Query Parameters:

  • id (string) – User Recording ID

  • stop_trail_seconds (number) – Additional time in seconds to include in the recording following the stop request.

Status Codes:
PUT /lidar-hub/api/v1/pcap_recording/stop_buffer

Stops the PCAP Ring Buffer.

Status Codes:
PUT /lidar-hub/api/v1/reset

Restart the Lidar Hub

Status Codes:
GET /lidar-hub/api/v1/user_recording/active

Get Active User Recording(s)

Status Codes:
POST /lidar-hub/api/v1/user_recording/start

Starts a User Recording.

Status Codes:
GET /lidar-hub/api/v1/user_recording/stop

Stops an active User Recording.

Query Parameters:

  • id (string) – User Recording ID

  • stop_trail_seconds (number) – Additional time in seconds to include in the recording following the stop request.

Status Codes:

Enrichments

POST /lidar-hub/api/v1/enrichments

Provide a new enrichment payload

Status Codes: