RoscoLive API v1.0(v2.35.0)
  1. Event
RoscoLive API v1.0(v2.35.0)
  • Event
    • Request custom video from device
      PUT
  • Company
    • create a company
      PUT
    • get a company by ID
      GET
    • update a company by ID
      POST
    • update company
      POST
    • get a company
      GET
    • get companies
      GET
    • get own partner company
      GET
  • Device
    • Geotab
      • Pair cameras to GO devices by CSV file
    • Play in-cab audible alert sound for device
      POST
    • Get a device
      GET
  • External Service
    • Get an external service account
      GET
    • Pair RL device with external device
      PUT
    • Get RL device data via external device unique serial number
      GET
  • Fleet Configuration
    • Create new profile in a company
      POST
    • Update a company profile
      POST
    • Get a company profile
      GET
    • Get profiles of a company
      GET
    • get profile history
      GET
  1. Event

Request custom video from device

PUT
https://fleet.roscolive.com/api/v1.0/events/custom_clips
Send a request to a camera for video and/or snapshots for a selected date-time window. After the request is sent, it will be processed and the request will be sent to the camera to retrieve the requested media.
Allowed duration can be from 5 seconds to 1 hour between start_ts and end_ts. Requested event will upload a video of the requested duration along with a snapshot which is taken from the "center" of the request.
For durations > 5 minutes, the request will be broken up into as many 5-minute duration events as it can, then the remaining will be made into its own event.
After a custom video request is submitted, the server will send the request to retrieve the media from the camera at the nearest opportunity. This event will be added to the event list for the company and can be retrieved using the returned event_id in the response.

User Role Permissions#

The following table shows which user roles are allowed to send requests using this API endpoint.
User RoleAllowed
Partner
Partner View
Custom Partner Requires permissions to be enabled
Fleet Manager
Group Manager
User
Custom User Requires permissions to be enabled

Considerations#

Here are some things to consider when implementing the custom video request API endpoint for your application.
Video Availability
Wake-up / Sleep mode
Foreshortened Event Video
Data Usage
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://fleet.roscolive.com/api/v1.0/events/custom_clips' \
--form 'device_id="1234567890"' \
--form 'start_ts="20240112132100"' \
--form 'end_ts="20240112132130"' \
--form 'custom_event_type=""' \
--form 'data="{ \"foo\": \"bar\" }"' \
--form 'event_display_type="My New Event"'
Response Response Example
200 - Success
{
    "meta": {
        "code": 200
    },
    "response": {
        "request_id": 1908766,
        "warning": "request exists"
    },
    "result": "OK"
}

Request

Body Params multipart/form-data

Responses

🟢200Request Exists
application/json
Body

🟢201Created
🟠400Bad Request
🟠401Login Required
🟠404404 (device doesn't exist)
Modified at 2025-06-15 10:46:58
Next
create a company
Built with