Skip to main content
POST
/
cube
Create cube (async)
curl --request POST \
  --url https://routing.solvice.io/cube \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "coordinates": [
    [
      123
    ]
  ],
  "sources": [
    123
  ],
  "destinations": [
    123
  ],
  "vehicleType": "CAR",
  "date": "2022-03-10T00:00:00.000Z",
  "responseType": "<string>"
}
'
{
  "id": 123,
  "status": "IN_PROGRESS",
  "errorMessage": "<string>",
  "responseType": "<string>",
  "hash": 123,
  "cubeResponseId": 123,
  "updatedAt": "<string>",
  "createdAt": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key authentication. Include your API key in the Authorization header.

Body

application/json

Cube Dto

​
coordinates
number<double>[][] | null
required

The coordinates this request will use, coordinates as [{lon},{lat}] values, in decimal degrees.

Minimum array length: 2
​
sources
integer<int32>[] | null

An array of index elements (0 <= integer < #coordinates) to use location with given index as source. Default is to use all.

​
destinations
integer<int32>[] | null

An array of index elements (0 <= integer < #coordinates) to use location with given index as destination. Default is to use all.

​
vehicleType
enum<string> | null

The vehicle type for which the table is requested

Available options:
CAR,
BIKE,
TRUCK,
ELECTRIC_CAR,
ELECTRIC_BIKE
​
date
string<date> | null

The date for which you want to calculate the cube. This will take into account predictive travel time based on TomTom data. Format YYYY-MM-DD. Default is current date.

Example:

"2022-03-10T00:00:00.000Z"

​
responseType
string | null

Specifies the type of response to return. Currently only 'matrix' is supported (returns travel time matrices for each time slice).

Response

OK

​
id
integer<int64>

Cube id.

​
status
enum<string> | null

Cube status (IN_PROGRESS, SUCCEEDED, FAILED).

Available options:
IN_PROGRESS,
AGGREGATING,
SUCCEEDED,
FAILED,
CREATING
​
errorMessage
string | null

Error message if the Cube failed.

​
responseType
string | null

Type of the Cube response, e.g., 'coefficients'.

​
hash
integer<int32> | null

Hash of the Cube request

​
cubeResponseId
integer<int64>

Cube response id.

​
updatedAt
string | null

Last update time of the Cube.

​
createdAt
string | null

Creation time of the Cube.