API Reference

Start a grid creation job

post
https://api.toqua.ai/ships//models//grid

Used for routing.

Start an asynchronous job to create either a single end-to-end grid, or three grids: one per subrelation. Each grid dimension is specified by a set of parameter values. Once the job is finished, a file containing the grids can be retrieved from the file endpoint. The maximum grid size is 5000000 rows.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required

Set to 'latest' to use the default model version

Query Params
string
Body Params

Optional text that describes the characteristics of this grid.

Specifies on which date the vessel's performance should be modelled. If left out, the most recent available date is used. If the date falls outside of the modelled range, a 400 error is returned.

Specifies whether to split the work of creating the grid into a separate grid for each subrelation. This decreases the processing time and table data size, at the expense of accuracy.

grid
object
required

Description of the values to be used for creating the grid. The resulting N-dimensional grid will be constructed as the combination between all provided ranges. Example: if the range of wind direction should be [0:180:45] (using [min:max:step] notation), then the value given to wind_direction should be [0, 45, 90, 135, 180]. If multi_grid is False, only 'sog' may be provided, else ('sog', 'stw' and 'me_power') must be provided.

Responses

404

Not Found

501

Not Implemented

Updated 10 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago