Preview Routing
curl --request GET \
--url https://api.example.com/api/v1/ops/routing/preview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/ops/routing/preview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/ops/routing/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/ops/routing/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/ops/routing/preview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/ops/routing/preview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/ops/routing/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"vehicleType": "VAN",
"status": "PARTIAL",
"distanceMeters": 12500,
"durationSeconds": 1800,
"segments": [
{
"type": "ROUTED",
"fromIndex": 0,
"toIndex": 2,
"pointIds": [
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b"
],
"polyline": "a~l~Fjk~uOwHJy@P",
"distanceMeters": 12500,
"durationSeconds": 1800
}
],
"points": [
{
"pointId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"name": "São Paulo",
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z",
"description": "Terminal Rodoviário Tietê",
"lat": -23.5155,
"lng": -46.6254,
"createdBy": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b",
"updatedBy": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b",
"deletedBy": null
}
],
"polyline": "a~l~Fjk~uOwHJy@P"
}{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Missing or invalid access token",
"statusCode": 401
}{
"message": "Insufficient permissions",
"statusCode": 403
}{
"message": "Internal Server Error",
"statusCode": 500
}Routing
Preview Routing
Previews routing.
GET
/
api
/
v1
/
ops
/
routing
/
preview
Preview Routing
curl --request GET \
--url https://api.example.com/api/v1/ops/routing/preview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/ops/routing/preview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/ops/routing/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/ops/routing/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/ops/routing/preview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/ops/routing/preview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/ops/routing/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"vehicleType": "VAN",
"status": "PARTIAL",
"distanceMeters": 12500,
"durationSeconds": 1800,
"segments": [
{
"type": "ROUTED",
"fromIndex": 0,
"toIndex": 2,
"pointIds": [
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b"
],
"polyline": "a~l~Fjk~uOwHJy@P",
"distanceMeters": 12500,
"durationSeconds": 1800
}
],
"points": [
{
"pointId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"name": "São Paulo",
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z",
"description": "Terminal Rodoviário Tietê",
"lat": -23.5155,
"lng": -46.6254,
"createdBy": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b",
"updatedBy": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b",
"deletedBy": null
}
],
"polyline": "a~l~Fjk~uOwHJy@P"
}{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Missing or invalid access token",
"statusCode": 401
}{
"message": "Insufficient permissions",
"statusCode": 403
}{
"message": "Internal Server Error",
"statusCode": 500
}Authorizations
bearerbearer
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Comma-separated point UUIDs in order
Example:
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a,0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b"
Vehicle type
Available options:
VAN Example:
"VAN"
Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.
Response
OK
Route preview
Vehicle type
Available options:
VAN Example:
"VAN"
Route preview status
Available options:
COMPLETE, PARTIAL, UNROUTABLE Example:
"PARTIAL"
Distance in meters
Example:
12500
Duration in seconds
Example:
1800
Route preview segments
Route preview segment
- Option 1
- Option 2
Show child attributes
Show child attributes
Hydrated points in input order
Show child attributes
Show child attributes
Encoded polyline
Example:
"a~l~Fjk~uOwHJy@P"