COcomma
routes

Update route

Changed on

Update route metadata. Authenticated user must have ownership of the device from which the route was uploaded.

patch/v1/route/{routeName}

Request

  • Base URL
    https://api.comma.ai
  • Auth
    HTTP bearer

Request body

ratinginteger

Route rating

is_publicboolean

Whether the route is publicly accessible

Example request

{
  "rating": 4,
  "is_public": true
}

Response

JSON object containing updated route information

fullnamestring required

Contains a dongle ID and timestamp of the beginning of the route

dongle_idstring required

A unique 16-character hexadecimal string. Can represent a device or a user.

user_idstring required

A unique 16-character hexadecimal string. Can represent a device or a user.

is_publicboolean

Route is publicly accessible

create_timeinteger required

Unix timestamp at which upload_url was first called for file in route

urlstring required

Signed storage bucket URL from which route.coords and JPEGs can be downloaded

share_expiryinteger required

Unix timestamp at which signed URL expires

share_sigstring required

URL signature

lengthnumber required

Sum of distances between GPS points in miles

canboolean

Route contains CAN messages

hpgpsboolean

Route has ublox packets

radarboolean

Route contains radar tracks in CAN

devicetype3 | 6 | 7 required

Data source

  • 3 = eon
  • 6 = comma two
  • 7 = comma three
maxqloginteger

Maximum qlog segment number uploaded

maxqcamerainteger

Maximum qcamera segment number uploaded

maxloginteger required

Maximum log segment number uploaded

maxcamerainteger required

Maximum road camera segment number uploaded

maxdcamerainteger required

Maximum driver camera segment number uploaded

maxecamerainteger

Maximum wide road camera segment number uploaded

procqloginteger

Maximum qlog segment number processed

procqcamerainteger

Maximum qcamera segment number processed

procloginteger required

Maximum log segment number processed

proccamerainteger required

Maximum road camera segment number processed

start_latnumber

First latitude recorded in route from GPS

start_lngnumber

First longitude recorded in route from GPS

start_timenumber required

Unix timestamp at beginning of route

end_latnumber

Last latitude recorded in route from GPS

end_lngnumber

Last longitude recorded in route from GPS

end_timenumber required

Unix timestamp at end of last segment in route

passiveboolean

openpilot is running in passive mode

versionstring

openpilot version

git_commitstring

git commit hash

git_branchstring

git branch

git_remotestring

git remote url

git_dirtyboolean

git working tree is dirty

platformstring

openpilot platform name

vinstring

17-character alphanumeric string

init_logmonotimeinteger

Minimum logMonoTime from openpilot log

Example response

{
  "fullname": "1a2b3c4d5e6f7a8b|2019-01-01--00-00-00",
  "dongle_id": "1a2b3c4d5e6f7a8b",
  "user_id": "1a2b3c4d5e6f7a8b",
  "vin": "5YJ3E1EA7HF000000"
}

Changes