API docs by Redocly

Knot Vehicles API - prod (v1.0)

Download OpenAPI specification:Download

Open battery cover

Request a vehicle to open the battery cover.

Authorizations:
(HttpSignatureAuthorizerApiGtwApiKey)
path Parameters
vehicleId
required
integer >= 1
header Parameters
X-Knot-Date
required
integer

Unix epoch in milliseconds of when the request was made.

X-Api-Key
required
string

The Api Key used to sign this request.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success"
}

Set config on a vehicle

Set a value for the specified configuration on a vehicle. The vehicle should be online to receive the new config value.

Authorizations:
(HttpSignatureAuthorizerApiGtwApiKey)
path Parameters
vehicleId
required
integer >= 1

The identifier of the vehicle.

header Parameters
X-Knot-Date
required
integer

Unix epoch in milliseconds of when the request was made.

X-Api-Key
required
string

The Api Key used to sign this request.

Request Body schema: application/json
required
lowSpeedLimit
integer [ 6 .. 25 ]

The maximum speed limit in low mode.

mediumSpeedLimit
integer [ 6 .. 25 ]

The maximum speed limit in medium mode.

highSpeedLimit
integer [ 6 .. 25 ]

The maximum speed limit in high mode.

cruiseControl
boolean

Enable the cruise controle.

buttonSwitchSpeedMode
boolean

Enable the scooter button to change the speed mode.

Responses

Request samples

Content type
application/json
{
  • "lowSpeedLimit": 6,
  • "mediumSpeedLimit": 6,
  • "highSpeedLimit": 6,
  • "cruiseControl": true,
  • "buttonSwitchSpeedMode": true
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success"
}

Set config throttle on a vehicle

Enable or disable the throttle of a vehicle. The vehicle should be online to receive the new config value.

Authorizations:
(HttpSignatureAuthorizerApiGtwApiKey)
path Parameters
vehicleId
required
integer >= 1

The identifier of the vehicle.

header Parameters
X-Knot-Date
required
integer

Unix epoch in milliseconds of when the request was made.

X-Api-Key
required
string

The Api Key used to sign this request.

Request Body schema: application/json
required
enabled
required
boolean

Enable the throttle.

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success"
}

Enable a vehicle

Enable a vehicle.

Authorizations:
(HttpSignatureAuthorizerApiGtwApiKey)
path Parameters
vehicleId
required
integer >= 1
header Parameters
X-Knot-Date
required
integer

Unix epoch in milliseconds of when the request was made.

X-Api-Key
required
string

The Api Key used to sign this request.

Request Body schema: application/json
optional
segway_qrcode
string

The QRCode of a Segway vehicle. If provided, the sleeve with be linked with the Segway access provided in the manager. This feature required to import your Segway scooter list in the manager.

Responses

Request samples

Content type
application/json
{
  • "segway_qrcode": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success"
}

Get a vehicle

Get a vehicle's information.

Authorizations:
(HttpSignatureAuthorizerApiGtwApiKey)
path Parameters
vehicleId
required
integer >= 1

The identifier of the vehicle.

header Parameters
X-Knot-Date
required
integer

Unix epoch in milliseconds of when the request was made.

X-Api-Key
required
string

The Api Key used to sign this request.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "data": {
    }
}

Get enabled vehicles

Get the list of enabled vehicles.

Authorizations:
(HttpSignatureAuthorizerApiGtwApiKey)
header Parameters
X-Knot-Date
required
integer

Unix epoch in milliseconds of when the request was made.

X-Api-Key
required
string

The Api Key used to sign this request.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "data": [
    ]
}

Get disabled vehicles

Get the list of disabled vehicles.

Authorizations:
(HttpSignatureAuthorizerApiGtwApiKey)
header Parameters
X-Knot-Date
required
integer

Unix epoch in milliseconds of when the request was made.

X-Api-Key
required
string

The Api Key used to sign this request.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "data": [
    ]
}

Set vehicle label and optional group

Define a label and optional group to the vehicle (custom name defined by the customer).

Authorizations:
(HttpSignatureAuthorizerApiGtwApiKey)
path Parameters
vehicleId
required
integer >= 1

The identifier of the vehicle.

header Parameters
X-Knot-Date
required
integer

Unix epoch in milliseconds of when the request was made.

X-Api-Key
required
string

The Api Key used to sign this request.

Request Body schema: application/json
required
label
required
string [ 1 .. 50 ] characters

The new label of the vehicle.

group
string or null [ 1 .. 50 ] characters

The new group of the vehicle

Responses

Request samples

Content type
application/json
{
  • "label": "string",
  • "group": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success"
}

Control vehicle light

Control the light state of a vehicle.

Authorizations:
(HttpSignatureAuthorizerApiGtwApiKey)
path Parameters
vehicleId
required
integer >= 1

The identifier of the vehicle.

header Parameters
X-Knot-Date
required
integer

Unix epoch in milliseconds of when the request was made.

X-Api-Key
required
string

The Api Key used to sign this request.

Request Body schema: application/json
required
state
required
string
Enum: "off" "on" "flicker"

The state on the light.

Responses

Request samples

Content type
application/json
{
  • "state": "off"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success"
}

Lock a vehicle

Lock a vehicle.

Authorizations:
(HttpSignatureAuthorizerApiGtwApiKey)
path Parameters
vehicleId
required
integer >= 1

The identifier of the vehicle.

header Parameters
X-Knot-Date
required
integer

Unix epoch in milliseconds of when the request was made.

X-Api-Key
required
string

The Api Key used to sign this request.

Request Body schema: application/json
required
lock
required
integer

An identifier to track this lock request. This will be sent back in the locked event.

Responses

Request samples

Content type
application/json
{
  • "lock": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success"
}

Shutdown a vehicle

Shutdown a vehicle. WARNING after shutting down a vehicle the only way to start it again is physically by plugin it in a charger.

Authorizations:
(HttpSignatureAuthorizerApiGtwApiKey)
path Parameters
vehicleId
required
integer >= 1

The identifier of the vehicle.

header Parameters
X-Knot-Date
required
integer

Unix epoch in milliseconds of when the request was made.

X-Api-Key
required
string

The Api Key used to sign this request.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success"
}

Play a sound

Request a vehicle to play a given sound.

Authorizations:
(HttpSignatureAuthorizerApiGtwApiKey)
path Parameters
vehicleId
required
integer >= 1

The identifier of the vehicle.

header Parameters
X-Knot-Date
required
integer

Unix epoch in milliseconds of when the request was made.

X-Api-Key
required
string

The Api Key used to sign this request.

Request Body schema: application/json
required
sound_type
required
string
Enum: "geo-fence" "toot" "low_battery"

The name of the sound to play.

Responses

Request samples

Content type
application/json
{
  • "sound_type": "geo-fence"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success"
}

Set speed mode on a vehicle

Set a specific speed mode on a vehicle.

Authorizations:
(HttpSignatureAuthorizerApiGtwApiKey)
path Parameters
vehicleId
required
integer >= 1

The identifier of the vehicle.

header Parameters
X-Knot-Date
required
integer

Unix epoch in milliseconds of when the request was made.

X-Api-Key
required
string

The Api Key used to sign this request.

Request Body schema: application/json
required
speed_mode
integer
Enum: 1 2 3

The speed mode (1 = low speed. 2 = medium speed. 3 = high speed).

Responses

Request samples

Content type
application/json
{
  • "speed_mode": 1
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success"
}

Unlock a vehicle

Unlock a vehicle.

Authorizations:
(HttpSignatureAuthorizerApiGtwApiKey)
path Parameters
vehicleId
required
integer >= 1

The identifier of the vehicle.

header Parameters
X-Knot-Date
required
integer

Unix epoch in milliseconds of when the request was made.

X-Api-Key
required
string

The Api Key used to sign this request.

Request Body schema: application/json
required
unlock
required
integer [ 1 .. 9007199254740991 ]

An identifier to track this unlock request. This will be sent back in the unlocked event.

ignore_station_status
boolean

Ignore the station status if the vehicle is in a spot. Useful for maintenance because it allows unlocking a vehicle when it has been manually removed from a disconnected station.

Responses

Request samples

Content type
application/json
{
  • "unlock": 5875,
  • "ignore_station_status": true
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success"
}