API docs by Redocly

Meili FMS API (2.0.0)

Download OpenAPI specification:Download

Engineering: info@meilirobots.com

Authentication

JWT (Json Web Token) authentication

JWT is the most common authentication method you will use. These are used in our frontend application.

Also these are the only tokens that can be used inter-domain in the same deployment

Authorization: Bearer [YOUR TOKEN]

User Persistent token authentication

Persistent tokens are similar to user tokens, but they will not be invalidated after a time period or when logging out.

Authorization: API-Key [YOUR TOKEN]

SDK Token authentication

SDK tokens are used for authenticating sdk based URLs and can be namespaced to prevent from too much access

Authorization: SDK-Key [YOUR TOKEN]

2nd generation (V2)

You will occasionally see that some sections have a V2 suffix, which means that those endpoints are second generation ones. The main difference between the two other than section specific changes is the possibility to expand related properties that are displayed as related keys (in most cases those are UUIDs).

To expand a property simply add expand query parameter with the desired key to expand.

Our API supports multiple expand keywords in the URL.

Example:

https://app.meilirobots.com/api/v2/team/your-team/tasks/

{
  ...
  "user": "b2a4038eaa6341d7a3cbe7c29635b1e3",
  ...
}

https://app.meilirobots.com/api/v2/team/your-team/tasks/?expand=user

{
  ...
  "user": {
    "uuid": "b2a4038eaa6341d7a3cbe7c29635b1e3",
    ...
  }
  ...
}

Dashboards

Get a list of user's team dashboards

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new dashboard view

Using this endpoint, you can create a new dashboard view It will be create as a copy of the default dashboard preset by the admin

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
title
string
is_default
boolean

Responses

Request samples

Content type
application/json
{
  • "title": "My View",
  • "is_default": false
}

Response samples

Content type
application/json
{
  • "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
  • "title": "My View",
  • "is_default": false,
  • "is_preset": false
}

Get list of pre-defined cards

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get dashboard with data

path Parameters
required
string or string

UUID or SLUG of the target resource

uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get dashboard with data filtered by dates or by vehicle categories

path Parameters
required
string or string

UUID or SLUG of the target resource

uuid
required
string <uuid>

UUID of the target resource

Request Body schema: application/json
from_date
string <date>
to_date
string <date>
vehicle_categories
Array of strings <uuid>

Responses

Request samples

Content type
application/json
{
  • "from_date": "2022-01-01",
  • "to_date": "2023-01-01",
  • "vehicle_categories": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete dashboard view

path Parameters
required
string or string

UUID or SLUG of the target resource

uuid
required
string <uuid>

UUID of the target resource

Responses

Reset dashboard cards to default system preset

path Parameters
required
string or string

UUID or SLUG of the target resource

uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Download data from dashboard view as CSV

path Parameters
required
string or string

UUID or SLUG of the target resource

uuid
required
string <uuid>

UUID of the target resource

Responses

Get cards from dashboard

path Parameters
required
string or string

UUID or SLUG of the target resource

uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create card from preset Or Edit/Delete cards inside an array

Using this endpoint, you can edit/delete cards inside an array If a card is not sent in the request body, it will be deleted Allows to change the location of the cards and other properties If sent as an object (dict) a new card will be created from the chosen preset.

path Parameters
required
string or string

UUID or SLUG of the target resource

uuid
required
string <uuid>

UUID of the target resource

Request Body schema: application/json
One of
title
string
location
required
number <integer>
card_preset
required
string <uuid>
display_type
string
unit
string
show_legend
boolean

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
[
  • {
    }
]

Edit card

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Request Body schema: application/json
title
string
location
number <integer>
display_type
string
unit
string
show_legend
boolean

Responses

Request samples

Content type
application/json
{
  • "title": "Total Tasks",
  • "location": 100,
  • "display_type": "number_comparison",
  • "unit": "meters/sec",
  • "show_legend": false
}

Response samples

Content type
application/json
[
  • {
    }
]

Get available display_types for card along with other params

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
null

Delete card from dashboard

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Get cards from dashboard

path Parameters
required
string or string

UUID or SLUG of the target resource

uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create card from preset Or Edit/Delete cards inside an array

Using this endpoint, you can edit/delete cards inside an array If a card is not sent in the request body, it will be deleted Allows to change the location of the cards and other properties If sent as an object (dict) a new card will be created from the chosen preset.

path Parameters
required
string or string

UUID or SLUG of the target resource

uuid
required
string <uuid>

UUID of the target resource

Request Body schema: application/json
One of
title
string
location
required
number <integer>
card_preset
required
string <uuid>
display_type
string
unit
string
show_legend
boolean

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
[
  • {
    }
]

Authentication

Create User Authentication details

Create User Authentication details

Request Body schema: application/json
email
required
string <email>
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "johndoe@meilirobots.com",
  • "password": "string"
}

Response samples

Content type
application/json
{}

Destroy user token

Destroy user token

Responses

Get a list of user persistent API tokens

Get a list of user persistent API tokens

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new persistent token

Create a new persistent token

Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "R1 Token"
}

Response samples

Content type
application/json
{
  • "uuid": "ed5a63a0caa045bc7d29ad24efd6591195523ece",
  • "name": "R1 Token",
  • "created": "2019-08-24T14:15:22Z",
  • "site": "app.meilirobots.com"
}

Get user persistent API token

Get user persistent API token

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "ed5a63a0caa045bc7d29ad24efd6591195523ece",
  • "name": "R1 Token",
  • "created": "2019-08-24T14:15:22Z",
  • "site": "app.meilirobots.com"
}

Delete user persistent API token

Delete user persistent API token

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Get a list of SDK tokens

List all SDK tokens belonging to the organization

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new SDK token

Create a new SDK token and attach it to the organization and the domain

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
name
required
string
task_access
boolean
vehicle_access
boolean
form_access
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "Task manager token",
  • "task_access": true,
  • "vehicle_access": true,
  • "form_access": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve SDK token by identifier

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "f5ab0e553f1f4d03b9e84fd5cb7c7b3a",
  • "name": "Task manager token",
  • "task_access": true,
  • "vehicle_access": true,
  • "form_access": true,
  • "created": "2019-08-24T14:15:22Z"
}

Delete SDK token

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

ActionTrail

ActionTrail is a part of the application that provides users insights into the decision making process of inside the FMS. Here we log decisions and details about them from developers perspective.

List logs inside a group

Return a list of group logs

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "next": null,
  • "page": 1,
  • "previous": null,
  • "results": [
    ]
}

Get detail log preview

If required you can get a detailed view of each log item including the serialized related objects, nature of their relationship as well as predefined set of extra details

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "02b4a0a9cc9246259b3911b31b3a8233",
  • "message": "Task moved to rerun queue due to insufficient vehicles",
  • "created_at": "2019-08-24T14:15:22Z",
  • "details": "At the moment of task allocation process there were no available vehicles connected\nto the FMS, therefore Task was moved to rerun status to be executed in later iteration\n",
  • "related_objects": [
    ]
}

List log groups

Return a list of team action log groups organized by time.

Logs are organized by hour

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Forms

Get form

Get form

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "e6a9741bd88d4e69bd5930010e9f4322",
  • "name": "Vehicle form",
  • "team": "7cf6aabb5116431fbab78efea4b783f0",
  • "target_object": "vehicle",
  • "variables": [
    ]
}

Update form

Update form

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
name
required
string
target_object
required
string
Enum: "vehicle" "task" "subtask" "task-preset" "subtask-preset"
required
Array of objects (FormVariable)

Responses

Request samples

Content type
application/json
{
  • "name": "Vehicle form",
  • "target_object": "vehicle",
  • "variables": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "e6a9741bd88d4e69bd5930010e9f4322",
  • "name": "Vehicle form",
  • "team": "7cf6aabb5116431fbab78efea4b783f0",
  • "target_object": "vehicle",
  • "variables": [
    ]
}

Delete form

Delete form

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Get object form entries

Get object form entries

path Parameters
uuid
required
string <uuid>

UUID of the target resource

object-type
required
string
Enum: "task" "subtask" "task-preset" "subtask-preset" "vehicle"

Verbose string of the type of the object

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ]
}

Update form entries for object

Update form entries for object

path Parameters
uuid
required
string <uuid>

UUID of the target resource

object-type
required
string
Enum: "task" "subtask" "task-preset" "subtask-preset" "vehicle"

Verbose string of the type of the object

Request Body schema: application/json
required
Array of objects (VariableEntry)

Responses

Request samples

Content type
application/json
{
  • "entries": [
    ]
}

Response samples

Content type
application/json
{
  • "entries": [
    ]
}

Get form for specific object

Get form for specific object

path Parameters
object-type
required
string
Enum: "task" "subtask" "task-preset" "subtask-preset" "vehicle"

Verbose string of the type of the object

uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "e6a9741bd88d4e69bd5930010e9f4322",
  • "name": "Vehicle form",
  • "team": "7cf6aabb5116431fbab78efea4b783f0",
  • "target_object": "vehicle",
  • "variables": [
    ]
}

Return a list of all forms for organization

Return a list of all forms for organization

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new form for organization

Create a new form for organization

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
name
required
string
target_object
required
string
Enum: "vehicle" "task" "subtask" "task-preset" "subtask-preset"
required
Array of objects (FormVariable)

Responses

Request samples

Content type
application/json
{
  • "name": "Vehicle form",
  • "target_object": "vehicle",
  • "variables": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "e6a9741bd88d4e69bd5930010e9f4322",
  • "name": "Vehicle form",
  • "team": "7cf6aabb5116431fbab78efea4b783f0",
  • "target_object": "vehicle",
  • "variables": [
    ]
}

Return a list of all variables available for organ

Return a list of all variables available for organization

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new variable for organization

Create a new variable for organization

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
name
required
string
variable_name
required
string <slug>
variable_type
required
string
Enum: "string" "integer" "float" "boolean"

Responses

Request samples

Content type
application/json
{
  • "name": "Autonomous",
  • "variable_name": "autonomous",
  • "variable_type": "boolean"
}

Response samples

Content type
application/json
{
  • "uuid": "e2e5878f2ed4466792e514a8f396e271",
  • "organization": "287c54aeaa534b71bc2cfd7762018ba4",
  • "name": "Autonomous",
  • "variable_name": "autonomous",
  • "variable_type": "boolean"
}

Indoors

Get indoor path

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "28efb1c889124304baa48dc195a04fce",
  • "points": [
    ],
  • "intermediate_points": [
    ],
  • "distance": 2.66,
  • "coordinate_list": [
    ],
  • "bidirectional": true
}

Update indoor path

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
intermediate_points
Array of numbers[ items ]
bidirectional
boolean
destination_points
required
Array of strings <uuid>

Responses

Request samples

Content type
application/json
{
  • "intermediate_points": [
    ],
  • "bidirectional": true,
  • "destination_points": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "28efb1c889124304baa48dc195a04fce",
  • "points": [
    ],
  • "intermediate_points": [
    ],
  • "distance": 2.66,
  • "coordinate_list": [
    ],
  • "bidirectional": true
}

Get indoor point

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "86992415878c4af992df1d2e05815284",
  • "name": "Top Corner",
  • "point_type": "drop_off",
  • "x": 88,
  • "y": 73,
  • "rotation": 0
}

Update indoor point

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Request Body schema: application/json
name
required
string
point_type
string
Enum: "drop_off" "charging"
x
required
number
y
required
number
rotation
number <float>

Responses

Request samples

Content type
application/json
{
  • "name": "Top Corner",
  • "point_type": "drop_off",
  • "x": 88,
  • "y": 73,
  • "rotation": 0
}

Response samples

Content type
application/json
{
  • "uuid": "86992415878c4af992df1d2e05815284",
  • "name": "Top Corner",
  • "point_type": "drop_off",
  • "x": 88,
  • "y": 73,
  • "rotation": 0
}

Delete indoor point

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "deleted": true,
  • "uuid": "49ced169d8f44808b0422cf5317d9e45"
}

Get indoor point docking routine

A charging point inside Meili FMS can have a docking routine defined for it. When a robot will be sent to such point, it will also receive docking routine to mount the point in specified way

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "path": [
    ],
  • "status": "recording",
  • "created_at": null
}

Start recording docking routine

Start recording docking routine for a point using a vehicle inside fleet. If vehicle is recording another routine, this request wll fail. After creation a message is sent to the robot to start recording routine

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Request Body schema: application/json
vehicle
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "vehicle": "e2e5878f2ed4466792e514a8f396e271"
}

Response samples

Content type
application/json
{
  • "path": [
    ],
  • "status": "recording",
  • "created_at": null
}

Finalize recording docking routine

Status is changed to finalizing and a message is dispatched to the robot to send back the recorded routine

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "path": [
    ],
  • "status": "recording",
  • "created_at": null
}

Delete docking routine

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

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

Get indoor team area

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "ce9f2e05d00740b7b3f9046c51a258ff",
  • "image": "string",
  • "image_dir": "string",
  • "image_url": "string",
  • "origin": [
    ],
  • "origin_x": 2.1,
  • "origin_y": 1.2,
  • "negate": 1,
  • "occupied_thresh": 0,
  • "original_height": 151,
  • "original_width": 120,
  • "map_analysis_tuning_parameter": 1000,
  • "version": "1b5b355fa34149acdd22c741fec4b3a0",
  • "image_details": "string"
}

Update indoor team area

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
origin_x
number <float>
origin_y
number <float>

Responses

Request samples

Content type
application/json
{
  • "origin_x": 2.1,
  • "origin_y": 1.2
}

Response samples

Content type
application/json
{
  • "uuid": "ce9f2e05d00740b7b3f9046c51a258ff",
  • "image": "string",
  • "image_dir": "string",
  • "image_url": "string",
  • "origin": [
    ],
  • "origin_x": 2.1,
  • "origin_y": 1.2,
  • "negate": 1,
  • "occupied_thresh": 0,
  • "original_height": 151,
  • "original_width": 120,
  • "map_analysis_tuning_parameter": 1000,
  • "version": "1b5b355fa34149acdd22c741fec4b3a0",
  • "image_details": "string"
}

Indoor Area Map Images

Retrieve a details about map area images including their URLs, build statuses

Responses

Get a list of indoor team area figures

path Parameters
required
string or string

UUID or SLUG of the target resource

figure-type
required
string
Value: "safezones"

Type of the area figures to return/create

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update/create area figures

Using this endpoint, you can create figures inside the area one-by-one or in batch

Note that in batch update/create zones of type specified in the URL that are not in request body will be automatically deleted

path Parameters
required
string or string

UUID or SLUG of the target resource

figure-type
required
string
Value: "safezones"

Type of the area figures to return/create

Request Body schema: application/json
Any of
uuid
string <uuid>

If present, it will update the figure with the provided value will be updated

title
required
string
points
required
Array of arrays

Responses

Request samples

Content type
application/json
Example
{
  • "uuid": "11495b9cca374e41a1cda9604169235b",
  • "title": "Area",
  • "points": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "uuid": "11495b9cca374e41a1cda9604169235b",
  • "title": "Area",
  • "points": [
    ],
  • "figure_type": "area"
}

Get Indoor Area of Interest

Area Of interest

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{
  • "x": 1,
  • "y": 2,
  • "width": 30,
  • "height": 70
}

Get indoor team paths

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new indoor path

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
intermediate_points
Array of numbers[ items ]
bidirectional
boolean
destination_points
required
Array of strings <uuid>

Responses

Request samples

Content type
application/json
{
  • "intermediate_points": [
    ],
  • "bidirectional": true,
  • "destination_points": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "28efb1c889124304baa48dc195a04fce",
  • "points": [
    ],
  • "intermediate_points": [
    ],
  • "distance": 2.66,
  • "coordinate_list": [
    ],
  • "bidirectional": true
}

Get indoor points

path Parameters
required
string or string

UUID or SLUG of the target resource

query Parameters
ordering
string
Enum: "name" "created_at" "updated_at"
Example: ordering=-name

Ordering of the results. Default is name. Accepts multiple values separated by comma. Use -name to reverse order.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new indoor point

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
name
required
string
point_type
string
Enum: "drop_off" "charging"
x
required
number
y
required
number
rotation
number <float>

Responses

Request samples

Content type
application/json
{
  • "name": "Top Corner",
  • "point_type": "drop_off",
  • "x": 88,
  • "y": 73,
  • "rotation": 0
}

Response samples

Content type
application/json
{
  • "uuid": "86992415878c4af992df1d2e05815284",
  • "name": "Top Corner",
  • "point_type": "drop_off",
  • "x": 88,
  • "y": 73,
  • "rotation": 0
}

Create Indoor Point From Vehicle Position

Save current vehicle position as an indoor point

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
name
required
string
point_type
string (PointType)
Enum: "entrance" "drop_off" "charging" "pass"
vehicle
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "name": "Pick up 14",
  • "point_type": "entrance",
  • "vehicle": "49ced169d8f44808b0422cf5317d9e45"
}

Response samples

Content type
application/json
{
  • "uuid": "36ee0ac1e01045758b52cef09451e908",
  • "name": "Pick up 14",
  • "point_type": "entrance",
  • "x": 0,
  • "y": 0,
  • "rotation": 0
}

Get indoor map analysis status

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{
  • "map_analysis_done": true,
  • "aoi_exists": true,
  • "status": "done"
}

Trigger map analysis

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

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

Update MA tuning parameters

Update Map Analysis tuning parameters and re-trigger map generation

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
map_analysis_sharpness
integer or null [ 0 .. 1000 ]

Responses

Request samples

Content type
application/json
{
  • "map_analysis_sharpness": 1000
}

Response samples

Content type
application/json
{
  • "map_analysis_sharpness": 1000
}

Upload indoor area image

Upload a new area image with yaml configuration file (optional) and trigger map analysis for the new map image

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: multipart/form-data
image
string <binary>
configuration_file
string or null <binary> (YamlAreaImageConfigurationFile)

Responses

Response samples

Content type
application/json
{
  • "uuid": "ce9f2e05d00740b7b3f9046c51a258ff",
  • "image": "string",
  • "image_dir": "string",
  • "image_url": "string",
  • "origin": [
    ],
  • "origin_x": 2.1,
  • "origin_y": 1.2,
  • "negate": 1,
  • "occupied_thresh": 0,
  • "original_height": 151,
  • "original_width": 120,
  • "map_analysis_tuning_parameter": 1000,
  • "version": "1b5b355fa34149acdd22c741fec4b3a0",
  • "image_details": "string"
}

Send update map message to all active vehicles within a team.

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
"string"

Zones

Get a list of team zones

path Parameters
required
string or string

UUID or SLUG of the target resource

zone-type
required
string
Enum: "charging" "resting" "forbidden" "restricted"

Type of the area zones to return/create

query Parameters
is_active
string
Enum: true false

Filter zones by active state

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update/create area zones

Using this endpoint, you can create zones inside the area one-by-one or in batch

Note that in batch update/create zones of type specified in the URL that are not in request body will be automatically deleted

path Parameters
required
string or string

UUID or SLUG of the target resource

zone-type
required
string
Enum: "charging" "resting" "forbidden" "restricted"

Type of the area zones to return/create

Request Body schema: application/json
Any of
title
string

The title of the zone

initial_point
Array of numbers

The initial point of the zone

points
Array of numbers[ items ]

The points defining the zone

zone_type
string
Enum: "area" "charging" "resting" "forbidden" "restricted"

The type of the zone

zone_dimensions
Array of numbers

The dimensions of the zone

safety_parameter
number <float>

The safety parameter of the zone (in meters)

speed_limit
number <float>

The speed limit of the zone (in meters/s)

vehicle_limit
number

The vehicle limit of the zone

is_active
boolean
Default: true

Indicates if the zone is active

priority
number or null [ 0 .. 5 ]
Default: 0

Indicates if the zone should have priority over other zones (default is 0 as no priority). The higher the number, the higher the priority.

allowed_vehicle_categories
Array of strings <uuid>

Responses

Request samples

Content type
application/json
Example
{
  • "title": "Charging Zone 1",
  • "initial_point": [
    ],
  • "points": [
    ],
  • "zone_type": "area",
  • "zone_dimensions": [
    ],
  • "safety_parameter": 0.5,
  • "speed_limit": 2.5,
  • "vehicle_limit": 1,
  • "is_active": false,
  • "priority": 5,
  • "allowed_vehicle_categories": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "title": "Charging Zone 1",
  • "points": [
    ],
  • "zone_type": "area",
  • "uuid": "11495b9cca374e41a1cda9604169235b",
  • "zone_dimensions": [
    ],
  • "safety_parameter": 0.5,
  • "speed_limit": 2.5,
  • "vehicle_limit": 1,
  • "is_active": false,
  • "priority": 5,
  • "allowed_vehicle_categories": [
    ]
}

Update area zones in bulk

Using this endpoint, you can create zones inside the area in batch

Zone_type must be sent with the object payload

Note that in batch update zones of type specified in the URL that are not in request body will be automatically deleted

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
Any of
title
string

The title of the zone

initial_point
Array of numbers

The initial point of the zone

points
Array of numbers[ items ]

The points defining the zone

zone_type
required
string
Enum: "area" "charging" "resting" "forbidden" "restricted"

The type of the zone

uuid
required
string <uuid>

The UUID of the zone to be updated

Responses

Request samples

Content type
application/json
{
  • "title": "Charging Zone 1",
  • "initial_point": [
    ],
  • "points": [
    ],
  • "zone_type": "area",
  • "uuid": "11495b9cca374e41a1cda9604169235b"
}

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve an area zone

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update an area zone

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Request Body schema: application/json
Any of
title
string

The title of the zone

initial_point
Array of numbers

The initial point of the zone

points
Array of numbers[ items ]

The points defining the zone

zone_type
string
Enum: "area" "charging" "resting" "forbidden" "restricted"

The type of the zone

zone_dimensions
Array of numbers

The dimensions of the zone

safety_parameter
number <float>

The safety parameter of the zone (in meters)

speed_limit
number <float>

The speed limit of the zone (in meters/s)

vehicle_limit
number

The vehicle limit of the zone

is_active
boolean
Default: true

Indicates if the zone is active

priority
number or null [ 0 .. 5 ]
Default: 0

Indicates if the zone should have priority over other zones (default is 0 as no priority). The higher the number, the higher the priority.

allowed_vehicle_categories
Array of strings <uuid>

Responses

Request samples

Content type
application/json
{
  • "title": "Charging Zone 1",
  • "initial_point": [
    ],
  • "points": [
    ],
  • "zone_type": "area",
  • "zone_dimensions": [
    ],
  • "safety_parameter": 0.5,
  • "speed_limit": 2.5,
  • "vehicle_limit": 1,
  • "is_active": false,
  • "priority": 5,
  • "allowed_vehicle_categories": [
    ]
}

Response samples

Content type
application/json
{
  • "title": "Charging Zone 1",
  • "points": [
    ],
  • "zone_type": "area",
  • "uuid": "11495b9cca374e41a1cda9604169235b",
  • "zone_dimensions": [
    ],
  • "safety_parameter": 0.5,
  • "speed_limit": 2.5,
  • "vehicle_limit": 1,
  • "is_active": false,
  • "priority": 5,
  • "allowed_vehicle_categories": [
    ]
}

Delete an area zone

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Get team zones paths

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new zones path

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
source_point
required
string <uuid>
destination_point
required
string <uuid>
points
Array of numbers[ items ]
is_active
boolean
Default: true
speed_limit
float
Default: -1

Responses

Request samples

Content type
application/json
{
  • "source_point": "86992415878c4af992df1d2e0581599b",
  • "destination_point": "86992415878c4af992df1d2e05815284",
  • "points": [
    ],
  • "is_active": false,
  • "speed_limit": 0.5
}

Response samples

Content type
application/json
{
  • "uuid": "28efb1c889124304baa48dc195a04fce",
  • "source_point": "86992415878c4af992df1d2e0581599b",
  • "destination_point": "86992415878c4af992df1d2e05815284",
  • "points": [
    ],
  • "distance": 2.66,
  • "is_active": false,
  • "speed_limit": 0.5
}

Get team stations

path Parameters
required
string or string

UUID or SLUG of the target resource

query Parameters
ordering
string
Enum: "name" "created_at" "updated_at"
Example: ordering=-name

Ordering of the results. Default is name. Accepts multiple values separated by comma. Use -name to reverse order.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new station

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
title
string
station_type
string (ZonesStationType)
Enum: "resting" "charging" "traversal" "default"
points
Array of numbers
rotation
number <float>
allowed_vehicle_categories
Array of strings <uuid>

Responses

Request samples

Content type
application/json
{
  • "title": "Charging Station 1",
  • "station_type": "resting",
  • "points": [
    ],
  • "rotation": 90,
  • "allowed_vehicle_categories": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "86992415878c4af992df1d2e05815284",
  • "title": "Charging Station 1",
  • "station_type": "resting",
  • "points": [
    ],
  • "rotation": 90,
  • "allowed_vehicle_categories": [
    ]
}

Get stations

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "86992415878c4af992df1d2e05815284",
  • "title": "Charging Station 1",
  • "station_type": "resting",
  • "points": [
    ],
  • "rotation": 90,
  • "allowed_vehicle_categories": [
    ]
}

Update station

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Request Body schema: application/json
title
string
station_type
string (ZonesStationType)
Enum: "resting" "charging" "traversal" "default"
points
Array of numbers
rotation
number <float>
allowed_vehicle_categories
Array of strings <uuid>

Responses

Request samples

Content type
application/json
{
  • "title": "Charging Station 1",
  • "station_type": "resting",
  • "points": [
    ],
  • "rotation": 90,
  • "allowed_vehicle_categories": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "86992415878c4af992df1d2e05815284",
  • "title": "Charging Station 1",
  • "station_type": "resting",
  • "points": [
    ],
  • "rotation": 90,
  • "allowed_vehicle_categories": [
    ]
}

Delete a station

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Get path

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "28efb1c889124304baa48dc195a04fce",
  • "source_point": "86992415878c4af992df1d2e0581599b",
  • "destination_point": "86992415878c4af992df1d2e05815284",
  • "points": [
    ],
  • "distance": 2.66,
  • "is_active": false,
  • "speed_limit": 0.5
}

Update path

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Request Body schema: application/json
source_point
required
string <uuid>
destination_point
required
string <uuid>
points
Array of numbers[ items ]
is_active
boolean
Default: true
speed_limit
float
Default: -1

Responses

Request samples

Content type
application/json
{
  • "source_point": "86992415878c4af992df1d2e0581599b",
  • "destination_point": "86992415878c4af992df1d2e05815284",
  • "points": [
    ],
  • "is_active": false,
  • "speed_limit": 0.5
}

Response samples

Content type
application/json
{
  • "uuid": "28efb1c889124304baa48dc195a04fce",
  • "source_point": "86992415878c4af992df1d2e0581599b",
  • "destination_point": "86992415878c4af992df1d2e05815284",
  • "points": [
    ],
  • "distance": 2.66,
  • "is_active": false,
  • "speed_limit": 0.5
}

Delete a path

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Resets team's area stations and paths

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Resets team's area zones

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Organizations

Return a list of organizations

Return a list of organizations

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new organization

Create a new organization

Request Body schema: application/json
title
required
string
default_email
required
string or null <email>
invitation_token
required
string
is_manufacturer
boolean
is_manufacturer_public
boolean
required
object (Address)
object (Address)

Responses

Request samples

Content type
application/json
{
  • "title": "Meili",
  • "default_email": "admin@meilirobots.com",
  • "invitation_token": "string",
  • "is_manufacturer": true,
  • "is_manufacturer_public": true,
  • "address": {
    },
  • "billing_address": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "287c54aeaa534b71bc2cfd7762018ba4",
  • "title": "Meili",
  • "slug": "meili",
  • "default_email": "admin@meilirobots.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "image": "string",
  • "is_manufacturer": true,
  • "is_manufacturer_public": true,
  • "address": {
    },
  • "billing_address": {
    }
}

Get organization by identifier

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "287c54aeaa534b71bc2cfd7762018ba4",
  • "title": "Meili",
  • "slug": "meili",
  • "default_email": "admin@meilirobots.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "image": "string",
  • "is_manufacturer": true,
  • "is_manufacturer_public": true,
  • "address": {
    },
  • "billing_address": {
    }
}

Update organization

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
title
required
string
default_email
required
string or null <email>
invitation_token
required
string
is_manufacturer
boolean
is_manufacturer_public
boolean
required
object (Address)
object (Address)

Responses

Request samples

Content type
application/json
{
  • "title": "Meili",
  • "default_email": "admin@meilirobots.com",
  • "invitation_token": "string",
  • "is_manufacturer": true,
  • "is_manufacturer_public": true,
  • "address": {
    },
  • "billing_address": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "287c54aeaa534b71bc2cfd7762018ba4",
  • "title": "Meili",
  • "slug": "meili",
  • "default_email": "admin@meilirobots.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "image": "string",
  • "is_manufacturer": true,
  • "is_manufacturer_public": true,
  • "address": {
    },
  • "billing_address": {
    }
}

Delete organization

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Return a list of members in organizations

Return a list of members in organizations

path Parameters
required
string or string

UUID or SLUG of the target resource

query Parameters
ordering
string
Enum: "created_at" "user" "membership_type"

Order objects by field To specify descending order, prefix the field name with a minus sign ("-"). Example: To order by "created_at" in descending order, use "-created_at".

Responses

Response samples

Content type
application/json
[]

Create a new invitation for user to organization

Create a new invitation for user to organization

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
object (User)
membership_type
string
Enum: "owner" "admin" "maintainer" "member" "observer"
email
string <email>

Responses

Request samples

Content type
application/json
{
  • "user": {
    },
  • "membership_type": "owner",
  • "email": "employee@meilirobots.com"
}

Response samples

Content type
application/json
{}

List all teams of the organization

List all teams of the organization

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
[]

Retrieve organization membership

Retrieve organization membership

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{}

Update organization membership

Update organization membership

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Request Body schema: application/json
object (User)
membership_type
required
string
Enum: "owner" "admin" "maintainer" "member" "observer"

Responses

Request samples

Content type
application/json
{
  • "user": {
    },
  • "membership_type": "owner"
}

Response samples

Content type
application/json
{}

Delete organization membership

Delete organization membership

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "ffbee424bcd24e98847a257f8bb81ab3"
}

Return a list of all vehicles in the organization

Return a list of all vehicles in the organization

path Parameters
required
string or string

UUID or SLUG of the target resource

query Parameters
ordering
string
Enum: "created_at" "verbose_name" "environment_type" "vehicle_type" "vehicle_serial_number" "priority_level" "category" "max_load" "integration_type"

Order objects by field To specify descending order, prefix the field name with a minus sign ("-"). Example: To order by "created_at" in descending order, use "-created_at".

team
string

Filter vehicles by team (team slug or title)

name
string

Filter vehicles by name (verbose_name)

slug
string

Filter vehicles by slug

category
string

Filter vehicles by category (category slug or title)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new vehicle for the organization

Create a new vehicle for the organization

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
external_identifier
string
verbose_name
string
environment_type
string
Enum: "inside" "outside"
vehicle_type
string
Enum: "amr" "agv"
active
required
boolean
category
string <uuid>
team
string <uuid>
full_battery
double
emergency_battery_level
double
emergency_distance
double
use_team_battery_defaults
boolean
manufacturer
string <uuid>
batch_tasks
boolean

If set to true, all tasks will be batched into a single message and approved as one

Responses

Request samples

Content type
application/json
{
  • "external_identifier": "Warehouse Left Wing Warrior",
  • "verbose_name": "Floating Flamingo",
  • "environment_type": "inside",
  • "vehicle_type": "amr",
  • "active": true,
  • "category": "c2bfb3237b874e238a7efa727d8485f8",
  • "team": "4c310b85696e4ffe9283f9bdfe2337f1",
  • "full_battery": null,
  • "emergency_battery_level": null,
  • "emergency_distance": null,
  • "use_team_battery_defaults": true,
  • "manufacturer": "287c54aeaa534b71bc2cfd7762018ba4",
  • "batch_tasks": true
}

Response samples

Content type
application/json
{
  • "uuid": "49ced169d8f44808b0422cf5317d9e45",
  • "external_identifier": "Warehouse Left Wing Warrior",
  • "verbose_name": "Floating Flamingo",
  • "slug": "floating-flamingo",
  • "environment_type": "inside",
  • "vehicle_type": "amr",
  • "active": true,
  • "category": "c2bfb3237b874e238a7efa727d8485f8",
  • "team": "4c310b85696e4ffe9283f9bdfe2337f1",
  • "full_battery": null,
  • "emergency_battery_level": null,
  • "emergency_distance": null,
  • "use_team_battery_defaults": true,
  • "manufacturer": "287c54aeaa534b71bc2cfd7762018ba4",
  • "batch_tasks": true
}

Return a list of all vehicle categories available

Return a list of all vehicle categories available in the organization

path Parameters
required
string or string

UUID or SLUG of the target resource

query Parameters
ordering
string
Enum: "created_at" "verbose_name" "environment_type" "vehicle_type" "vehicle_serial_number" "priority_level" "category" "max_load" "integration_type"

Order objects by field To specify descending order, prefix the field name with a minus sign ("-"). Example: To order by "created_at" in descending order, use "-created_at".

team
string

Filter vehicles by team (team slug or title)

name
string

Filter vehicles by name (verbose_name)

slug
string

Filter vehicles by slug

category
string

Filter vehicles by category (category slug or title)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new vehicle category for the organization

Create a new vehicle category for the organization

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
title
string
max_load
number

The maximum load of the vehicle category in Kg

dimensions
Array of numbers

The dimensions of the vehicle category

container_dimensions
Array of numbers

The container dimensions of the vehicle category

vehicle_type
string
Enum: "amr" "agv"

The type of the vehicle category

extra_details
object

Extra details of the vehicle category

Responses

Request samples

Content type
application/json
{
  • "title": "Floating Flamingo",
  • "max_load": 100,
  • "dimensions": [
    ],
  • "container_dimensions": [
    ],
  • "vehicle_type": "amr",
  • "extra_details": { }
}

Response samples

Content type
application/json
{
  • "uuid": "49ced169d8f44808b0422cf5317d9e45",
  • "title": "Floating Flamingo",
  • "slug": "floating-flamingo",
  • "is_global": false,
  • "max_load": 100,
  • "dimensions": [
    ],
  • "container_dimensions": [
    ],
  • "vehicle_type": "amr",
  • "extra_details": { }
}

Get a list of SDK tokens

List all SDK tokens belonging to the organization

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new SDK token

Create a new SDK token and attach it to the organization and the domain

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
name
required
string
task_access
boolean
vehicle_access
boolean
form_access
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "Task manager token",
  • "task_access": true,
  • "vehicle_access": true,
  • "form_access": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Download organization zipped data

Download organization zipped data

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Import zip file data to organization

Import zip file data to organization

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: multipart/form-data
file
string <binary>

Responses

Vehicles

Return a list of all vehicles in the organization

Return a list of all vehicles in the organization

path Parameters
required
string or string

UUID or SLUG of the target resource

query Parameters
ordering
string
Enum: "created_at" "verbose_name" "environment_type" "vehicle_type" "vehicle_serial_number" "priority_level" "category" "max_load" "integration_type"

Order objects by field To specify descending order, prefix the field name with a minus sign ("-"). Example: To order by "created_at" in descending order, use "-created_at".

team
string

Filter vehicles by team (team slug or title)

name
string

Filter vehicles by name (verbose_name)

slug
string

Filter vehicles by slug

category
string

Filter vehicles by category (category slug or title)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new vehicle for the organization

Create a new vehicle for the organization

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
external_identifier
string
verbose_name
string
environment_type
string
Enum: "inside" "outside"
vehicle_type
string
Enum: "amr" "agv"
active
required
boolean
category
string <uuid>
team
string <uuid>
full_battery
double
emergency_battery_level
double
emergency_distance
double
use_team_battery_defaults
boolean
manufacturer
string <uuid>
batch_tasks
boolean

If set to true, all tasks will be batched into a single message and approved as one

Responses

Request samples

Content type
application/json
{
  • "external_identifier": "Warehouse Left Wing Warrior",
  • "verbose_name": "Floating Flamingo",
  • "environment_type": "inside",
  • "vehicle_type": "amr",
  • "active": true,
  • "category": "c2bfb3237b874e238a7efa727d8485f8",
  • "team": "4c310b85696e4ffe9283f9bdfe2337f1",
  • "full_battery": null,
  • "emergency_battery_level": null,
  • "emergency_distance": null,
  • "use_team_battery_defaults": true,
  • "manufacturer": "287c54aeaa534b71bc2cfd7762018ba4",
  • "batch_tasks": true
}

Response samples

Content type
application/json
{
  • "uuid": "49ced169d8f44808b0422cf5317d9e45",
  • "external_identifier": "Warehouse Left Wing Warrior",
  • "verbose_name": "Floating Flamingo",
  • "slug": "floating-flamingo",
  • "environment_type": "inside",
  • "vehicle_type": "amr",
  • "active": true,
  • "category": "c2bfb3237b874e238a7efa727d8485f8",
  • "team": "4c310b85696e4ffe9283f9bdfe2337f1",
  • "full_battery": null,
  • "emergency_battery_level": null,
  • "emergency_distance": null,
  • "use_team_battery_defaults": true,
  • "manufacturer": "287c54aeaa534b71bc2cfd7762018ba4",
  • "batch_tasks": true
}

Return a list of all vehicle categories available

Return a list of all vehicle categories available in the organization

path Parameters
required
string or string

UUID or SLUG of the target resource

query Parameters
ordering
string
Enum: "created_at" "verbose_name" "environment_type" "vehicle_type" "vehicle_serial_number" "priority_level" "category" "max_load" "integration_type"

Order objects by field To specify descending order, prefix the field name with a minus sign ("-"). Example: To order by "created_at" in descending order, use "-created_at".

team
string

Filter vehicles by team (team slug or title)

name
string

Filter vehicles by name (verbose_name)

slug
string

Filter vehicles by slug

category
string

Filter vehicles by category (category slug or title)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new vehicle category for the organization

Create a new vehicle category for the organization

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
title
string
max_load
number

The maximum load of the vehicle category in Kg

dimensions
Array of numbers

The dimensions of the vehicle category

container_dimensions
Array of numbers

The container dimensions of the vehicle category

vehicle_type
string
Enum: "amr" "agv"

The type of the vehicle category

extra_details
object

Extra details of the vehicle category

Responses

Request samples

Content type
application/json
{
  • "title": "Floating Flamingo",
  • "max_load": 100,
  • "dimensions": [
    ],
  • "container_dimensions": [
    ],
  • "vehicle_type": "amr",
  • "extra_details": { }
}

Response samples

Content type
application/json
{
  • "uuid": "49ced169d8f44808b0422cf5317d9e45",
  • "title": "Floating Flamingo",
  • "slug": "floating-flamingo",
  • "is_global": false,
  • "max_load": 100,
  • "dimensions": [
    ],
  • "container_dimensions": [
    ],
  • "vehicle_type": "amr",
  • "extra_details": { }
}

Return a list of all vehicles in the team's fleet

Return a list of all vehicles in the team's fleet

path Parameters
required
string or string

UUID or SLUG of the target resource

query Parameters
name
string

Filter vehicles by name (verbose_name)

slug
string

Filter vehicles by slug

category
string
Examples: category=category_slug category=category_title

Filter vehicles by category

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add vehicles to fleet

Add vehicles to fleet

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
vehicles
required
Array of strings

Request samples

Content type
application/json
{
  • "vehicles": [
    ]
}

Remove a vehicle to fleet

Remove a vehicle to fleet

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
uuid
string <uuid>
slug
string

Responses

Request samples

Content type
application/json
{
  • "uuid": "49ced169d8f44808b0422cf5317d9e45",
  • "slug": "floating-flamingo"
}

Update vehicle fleet profile

Update vehicle fleet profile

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Request Body schema: application/json
team
string <uuid>
purge_vehicle_profile
boolean

If set to false, it will keep the values set on the profile

active
boolean

If marked false, it will taken out of the calculations for task assignment

Responses

Request samples

Content type
application/json
{
  • "team": "7cf6aabb5116431fbab78efea4b783f0",
  • "purge_vehicle_profile": true,
  • "active": true
}

Response samples

Content type
application/json
{
  • "team": "7cf6aabb5116431fbab78efea4b783f0",
  • "active": true
}

Update a vehicle category

Update a vehicle category

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
title
string
max_load
number

The maximum load of the vehicle category in Kg

dimensions
Array of numbers

The dimensions of the vehicle category

container_dimensions
Array of numbers

The container dimensions of the vehicle category

vehicle_type
string
Enum: "amr" "agv"

The type of the vehicle category

extra_details
object

Extra details of the vehicle category

Responses

Request samples

Content type
application/json
{
  • "title": "Floating Flamingo",
  • "max_load": 100,
  • "dimensions": [
    ],
  • "container_dimensions": [
    ],
  • "vehicle_type": "amr",
  • "extra_details": { }
}

Response samples

Content type
application/json
{
  • "uuid": "49ced169d8f44808b0422cf5317d9e45",
  • "title": "Floating Flamingo",
  • "slug": "floating-flamingo",
  • "is_global": false,
  • "max_load": 100,
  • "dimensions": [
    ],
  • "container_dimensions": [
    ],
  • "vehicle_type": "amr",
  • "extra_details": { }
}

Delete a vehicle category

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Tasks

This section of our API documentation will document the functionality of Tasks.

Note: Please see Tasks V2 part of our documentation to use the latest version of the API that includes latest developments.

Return scheduled tasks

Return scheduled tasks

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "17fdb48466104825b800d791c6a813d7",
  • "name": "Schedule for preset Recurring preset",
  • "preset": "20128c30066b4c6dbb1261d0c5387c11",
  • "date": "2019-08-24",
  • "time": "14:15:22Z",
  • "enabled": true,
  • "one_time": true,
  • "week_days": [
    ],
  • "task_preset": {
    },
  • "date_tz": "2019-08-24",
  • "time_tz": "14:15:22Z",
  • "week_days_tz": [
    ],
  • "offline": true,
  • "execute_every": 0,
  • "vehicle_uuid": "49ced169d8f44808b0422cf5317d9e45",
  • "cron": "*/5 * * * *",
  • "active_from": "14:15:22Z",
  • "active_to": "14:15:22Z",
  • "active_from_tz": "14:15:22Z",
  • "active_to_tz": "14:15:22Z"
}

Update scheduled task

Update scheduled task

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
name
string
preset
string <uuid>
date
string <date>
time
string <time>
enabled
boolean
week_days
Array of integers (Weekdays)
Items Enum: 0 1 2 3 4 5 6
required
object (TaskPreset)
week_days_tz
Array of integers (Weekdays)
Items Enum: 0 1 2 3 4 5 6
offline
boolean
execute_every
integer
vehicle_uuid
string or null <uuid>
active_from
string or null <time>
active_to
string or null <time>

Responses

Request samples

Content type
application/json
{
  • "name": "Schedule for preset Recurring preset",
  • "preset": "20128c30066b4c6dbb1261d0c5387c11",
  • "date": "2019-08-24",
  • "time": "14:15:22Z",
  • "enabled": true,
  • "week_days": [
    ],
  • "task_preset": {
    },
  • "week_days_tz": [
    ],
  • "offline": true,
  • "execute_every": 0,
  • "vehicle_uuid": "49ced169d8f44808b0422cf5317d9e45",
  • "active_from": "14:15:22Z",
  • "active_to": "14:15:22Z"
}

Response samples

Content type
application/json
{
  • "uuid": "17fdb48466104825b800d791c6a813d7",
  • "name": "Schedule for preset Recurring preset",
  • "preset": "20128c30066b4c6dbb1261d0c5387c11",
  • "date": "2019-08-24",
  • "time": "14:15:22Z",
  • "enabled": true,
  • "one_time": true,
  • "week_days": [
    ],
  • "task_preset": {
    },
  • "date_tz": "2019-08-24",
  • "time_tz": "14:15:22Z",
  • "week_days_tz": [
    ],
  • "offline": true,
  • "execute_every": 0,
  • "vehicle_uuid": "49ced169d8f44808b0422cf5317d9e45",
  • "cron": "*/5 * * * *",
  • "active_from": "14:15:22Z",
  • "active_to": "14:15:22Z",
  • "active_from_tz": "14:15:22Z",
  • "active_to_tz": "14:15:22Z"
}

Fail task and the remaining subtasks

Fail task and the remaining subtasks

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Cancel next execution of a scheduled task

Cancel next execution of a scheduled task

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "17fdb48466104825b800d791c6a813d7",
  • "scheduled_task": "17fdb48466104825b800d791c6a813d7",
  • "from_time": "2020-01-01T00:00+01:00",
  • "to_time": "2023-11-01T23:00+01:00"
}

Reactivate next execution of a scheduled task

Reactivate next execution of a scheduled task

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Return task

Return task

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "11495b9cca374e41a1cda9604169235b",
  • "number": "20220113_0543",
  • "task_status": "created",
  • "created_at": "2019-08-24T14:15:22Z",
  • "executed_at": "2019-08-24T14:15:22Z",
  • "disconnected": "2019-08-24T14:15:22Z",
  • "seen": true,
  • "user": {},
  • "vehicle": {
    },
  • "subtasks": [
    ],
  • "relaunched_from": "4b1a2e81219349808207e366907040bc",
  • "is_relaunchable": true,
  • "auto_confirmation": true,
  • "confirmation_methods": [
    ],
  • "preset": "f7e0568514c14357a974cb716ea88c2d",
  • "scheduled_task": "aaa25487c17b4ddeaabf06cf4c5b2cf8"
}

Confirm leg of the task

Confirm leg of the task

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "11495b9cca374e41a1cda9604169235b",
  • "number": "20220113_0543",
  • "task_status": "created",
  • "created_at": "2019-08-24T14:15:22Z",
  • "executed_at": "2019-08-24T14:15:22Z",
  • "disconnected": "2019-08-24T14:15:22Z",
  • "seen": true,
  • "user": {},
  • "vehicle": {
    },
  • "subtasks": [
    ],
  • "relaunched_from": "4b1a2e81219349808207e366907040bc",
  • "is_relaunchable": true,
  • "auto_confirmation": true,
  • "confirmation_methods": [
    ],
  • "preset": "f7e0568514c14357a974cb716ea88c2d",
  • "scheduled_task": "aaa25487c17b4ddeaabf06cf4c5b2cf8"
}

Relaunch or mark task as seen

Relaunch or mark task as seen

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
seen
boolean
relaunch
boolean

Responses

Request samples

Content type
application/json
{
  • "seen": true,
  • "relaunch": true
}

Response samples

Content type
application/json
{
  • "uuid": "11495b9cca374e41a1cda9604169235b",
  • "number": "20220113_0543",
  • "task_status": "created",
  • "created_at": "2019-08-24T14:15:22Z",
  • "executed_at": "2019-08-24T14:15:22Z",
  • "disconnected": "2019-08-24T14:15:22Z",
  • "seen": true,
  • "user": {},
  • "vehicle": {
    },
  • "subtasks": [
    ],
  • "relaunched_from": "4b1a2e81219349808207e366907040bc",
  • "is_relaunchable": true,
  • "auto_confirmation": true,
  • "confirmation_methods": [
    ],
  • "preset": "f7e0568514c14357a974cb716ea88c2d",
  • "scheduled_task": "aaa25487c17b4ddeaabf06cf4c5b2cf8"
}

Fail task and the remaining subtasks

Fail task and the remaining subtasks

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "11495b9cca374e41a1cda9604169235b",
  • "number": "20220113_0543",
  • "task_status": "created",
  • "created_at": "2019-08-24T14:15:22Z",
  • "executed_at": "2019-08-24T14:15:22Z",
  • "disconnected": "2019-08-24T14:15:22Z",
  • "seen": true,
  • "user": {},
  • "vehicle": {
    },
  • "subtasks": [
    ],
  • "relaunched_from": "4b1a2e81219349808207e366907040bc",
  • "is_relaunchable": true,
  • "auto_confirmation": true,
  • "confirmation_methods": [
    ],
  • "preset": "f7e0568514c14357a974cb716ea88c2d",
  • "scheduled_task": "aaa25487c17b4ddeaabf06cf4c5b2cf8"
}

Return task preset

Return task preset

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "20128c30066b4c6dbb1261d0c5387c11",
  • "title": "Recurring preset",
  • "slug": "recurring-preset",
  • "subtasks": [
    ],
  • "confirmation_methods": [
    ],
  • "auto_confirmation": true
}

Launch a task from preset

Launch a task from preset

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
number
string or null
auto_confirmation
boolean
looped_task
boolean
priority_level
integer

Responses

Request samples

Content type
application/json
{
  • "number": "20200113_0451",
  • "auto_confirmation": true,
  • "looped_task": true,
  • "priority_level": 0
}

Response samples

Content type
application/json
{
  • "uuid": "11495b9cca374e41a1cda9604169235b",
  • "number": "20220113_0543",
  • "task_status": "created",
  • "created_at": "2019-08-24T14:15:22Z",
  • "executed_at": "2019-08-24T14:15:22Z",
  • "disconnected": "2019-08-24T14:15:22Z",
  • "seen": true,
  • "user": {},
  • "vehicle": {
    },
  • "subtasks": [
    ],
  • "relaunched_from": "4b1a2e81219349808207e366907040bc",
  • "is_relaunchable": true,
  • "auto_confirmation": true,
  • "confirmation_methods": [
    ],
  • "preset": "f7e0568514c14357a974cb716ea88c2d",
  • "scheduled_task": "aaa25487c17b4ddeaabf06cf4c5b2cf8"
}

Update task preset

Update task preset

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
title
required
string
required
Array of objects (SubtaskPreset)
confirmation_methods
Array of strings (ConfirmationMethodList)
Items Enum: "user" "auto" "workflow" "trigger"
auto_confirmation
boolean

Responses

Request samples

Content type
application/json
{
  • "title": "Recurring preset",
  • "subtasks": [
    ],
  • "confirmation_methods": [
    ],
  • "auto_confirmation": true
}

Response samples

Content type
application/json
{
  • "uuid": "20128c30066b4c6dbb1261d0c5387c11",
  • "title": "Recurring preset",
  • "slug": "recurring-preset",
  • "subtasks": [
    ],
  • "confirmation_methods": [
    ],
  • "auto_confirmation": true
}

Delete task preset

Delete task preset

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Return a list of team tasks

Return a list of team tasks

path Parameters
required
string or string

UUID or SLUG of the target resource

query Parameters
user
string
Enum: "self" "user@email.com"

Filter tasks by user

time
string
Enum: "today" "yesterday" "week"

Filter tasks by time period

range
string
Examples: range=2020-01-01T00:00:00/2020-01-01T23:59:59 range=2024 range=2024-01 range=2024-01-01 range=2024-01-01T00:00:00/2024-01-03

Filter tasks by exact time range,The range can be a single date/datetime or a date/datetime range.,It expects the date/datetime in the team's timezone.

state
string
Enum: "progressing" "executed"

Filter tasks by state

status
string
Enum: "created" "pending" "rerun" "sent" "terminated" "in_progress" "completed" "aborted" "failed" "failed_offline" "completed_offline" "offline"

Filter tasks by status

vehicle_slug
string
Example: vehicle_slug=v1

Filter tasks by vehicle slug

vehicle_verbose_name
string
Example: vehicle_verbose_name=v1

Filter tasks by vehicle verbose name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new task for the team

Create a new task for the team

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
number
string
required
Array of objects (SubtaskCreationObject)
auto_confirmation
boolean
confirmation_methods
Array of strings (ConfirmationMethodList)
Items Enum: "user" "auto" "workflow" "trigger"
vehicle_uuid
string <uuid>

If specified, FMS will automatically assign the selected vehicle and skip allocation

vehicle_category_uuid
string <uuid>

If specified, FMS will only selected vehicles from the given category

Responses

Request samples

Content type
application/json
{
  • "number": "20220113_0543",
  • "tasks": [
    ],
  • "auto_confirmation": true,
  • "confirmation_methods": [
    ],
  • "vehicle_uuid": "49ced169d8f44808b0422cf5317d9e45",
  • "vehicle_category_uuid": "c2bfb3237b874e238a7efa727d8485f8"
}

Response samples

Content type
application/json
{
  • "uuid": "11495b9cca374e41a1cda9604169235b",
  • "number": "20220113_0543",
  • "task_status": "created",
  • "created_at": "2019-08-24T14:15:22Z",
  • "executed_at": "2019-08-24T14:15:22Z",
  • "disconnected": "2019-08-24T14:15:22Z",
  • "seen": true,
  • "user": {},
  • "vehicle": {
    },
  • "subtasks": [
    ],
  • "relaunched_from": "4b1a2e81219349808207e366907040bc",
  • "is_relaunchable": true,
  • "auto_confirmation": true,
  • "confirmation_methods": [
    ],
  • "preset": "f7e0568514c14357a974cb716ea88c2d",
  • "scheduled_task": "aaa25487c17b4ddeaabf06cf4c5b2cf8"
}

Cancel all tasks for the team

Cancel all tasks for the team

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Return a list of team task presets

Return a list of team task presets

path Parameters
required
string or string

UUID or SLUG of the target resource

query Parameters
title
string

Filter task presets by title

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new task preset for the team

Create a new task preset for the team

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
title
required
string
required
Array of objects (SubtaskPreset)
confirmation_methods
Array of strings (ConfirmationMethodList)
Items Enum: "user" "auto" "workflow" "trigger"
auto_confirmation
boolean

Responses

Request samples

Content type
application/json
{
  • "title": "Recurring preset",
  • "subtasks": [
    ],
  • "confirmation_methods": [
    ],
  • "auto_confirmation": true
}

Response samples

Content type
application/json
{
  • "uuid": "20128c30066b4c6dbb1261d0c5387c11",
  • "title": "Recurring preset",
  • "slug": "recurring-preset",
  • "subtasks": [
    ],
  • "confirmation_methods": [
    ],
  • "auto_confirmation": true
}

Mark all terminated tasks as "seen"

Mark all terminated tasks as "seen"

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Return a list of team task schedules

Return a list of team task schedules

path Parameters
required
string or string

UUID or SLUG of the target resource

query Parameters
enabled
string
Enum: true false

Filter tasks by enabled state

type
string
Enum: "one-time" "repeating"

Filter tasks by type

show_all
string
Enum: true false

Returns only upcoming if show_all is not specified

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new task schedule for the team

Create a new task schedule for the team

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
name
string
preset
string <uuid>
date
string <date>
time
string <time>
enabled
boolean
week_days
Array of integers (Weekdays)
Items Enum: 0 1 2 3 4 5 6
required
object (TaskPreset)
week_days_tz
Array of integers (Weekdays)
Items Enum: 0 1 2 3 4 5 6
offline
boolean
execute_every
integer
vehicle_uuid
string or null <uuid>
active_from
string or null <time>
active_to
string or null <time>

Responses

Request samples

Content type
application/json
{
  • "name": "Schedule for preset Recurring preset",
  • "preset": "20128c30066b4c6dbb1261d0c5387c11",
  • "date": "2019-08-24",
  • "time": "14:15:22Z",
  • "enabled": true,
  • "week_days": [
    ],
  • "task_preset": {
    },
  • "week_days_tz": [
    ],
  • "offline": true,
  • "execute_every": 0,
  • "vehicle_uuid": "49ced169d8f44808b0422cf5317d9e45",
  • "active_from": "14:15:22Z",
  • "active_to": "14:15:22Z"
}

Response samples

Content type
application/json
{
  • "uuid": "17fdb48466104825b800d791c6a813d7",
  • "name": "Schedule for preset Recurring preset",
  • "preset": "20128c30066b4c6dbb1261d0c5387c11",
  • "date": "2019-08-24",
  • "time": "14:15:22Z",
  • "enabled": true,
  • "one_time": true,
  • "week_days": [
    ],
  • "task_preset": {
    },
  • "date_tz": "2019-08-24",
  • "time_tz": "14:15:22Z",
  • "week_days_tz": [
    ],
  • "offline": true,
  • "execute_every": 0,
  • "vehicle_uuid": "49ced169d8f44808b0422cf5317d9e45",
  • "cron": "*/5 * * * *",
  • "active_from": "14:15:22Z",
  • "active_to": "14:15:22Z",
  • "active_from_tz": "14:15:22Z",
  • "active_to_tz": "14:15:22Z"
}

Pause specified task

Pause specified task

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Resume specified task

Resume specified task

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Tasks V2

This section of our API documentation will document the details of the second generation tasks.

The main difference between the v1 and v2 being configurable task actions which introduces more flexibility, but also at the same time more complexity to the endpoints.

Get a list of team tasks

query Parameters
user
string
Enum: "self" "user@email.com"

Filter tasks by user

time
string
Enum: "today" "yesterday" "week"

Filter tasks by time period

range
string
Examples: range=2020-01-01T00:00:00/2020-01-01T23:59:59 range=2024 range=2024-01 range=2024-01-01 range=2024-01-01T00:00:00/2024-01-03

Filter tasks by exact time range,The range can be a single date/datetime or a date/datetime range.,It expects the date/datetime in the team's timezone.

state
string
Enum: "progressing" "executed"

Filter tasks by state

status
string
Enum: "created" "pending" "rerun" "sent" "terminated" "in_progress" "completed" "aborted" "failed" "failed_offline" "completed_offline" "offline"

Filter tasks by status

vehicle_slug
string
Example: vehicle_slug=v1

Filter tasks by vehicle slug

vehicle_verbose_name
string
Example: vehicle_verbose_name=v1

Filter tasks by vehicle verbose name

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "next": "string",
  • "page": 1,
  • "previous": "string",
  • "results": [
    ]
}

Create a new task

Request Body schema: application/json
number
string
priority_level
integer
auto_confirmation
boolean
confirmation_methods
Array of strings (ConfirmationMethodList)
Items Enum: "user" "auto" "workflow" "trigger"
vehicle
string <uuid>
required_vehicle_category
string <uuid>
looped_task
boolean
abort_decision
integer
required
Array of objects (tasks_Subtask)

Responses

Request samples

Content type
application/json
{
  • "number": "20220113_0543",
  • "priority_level": 50,
  • "auto_confirmation": true,
  • "confirmation_methods": [
    ],
  • "vehicle": "49ced169d8f44808b0422cf5317d9e45",
  • "required_vehicle_category": "c2bfb3237b874e238a7efa727d8485f8",
  • "looped_task": true,
  • "abort_decision": 0,
  • "subtasks": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "11495b9cca374e41a1cda9604169235b",
  • "number": "20220113_0543",
  • "status": "created",
  • "seen": true,
  • "priority_level": 50,
  • "auto_confirmation": true,
  • "confirmation_methods": [
    ],
  • "can_be_confirmed": true,
  • "can_be_relaunched": true,
  • "relaunched_from": "7c2a734c-6bd1-4710-9e0f-c8542192fe44",
  • "relaunched_task": "5f06ebe5-f11a-41db-8ce6-6788a157162f",
  • "vehicle": "49ced169d8f44808b0422cf5317d9e45",
  • "required_vehicle_category": "c2bfb3237b874e238a7efa727d8485f8",
  • "looped_task": true,
  • "abort_decision": 0,
  • "subtasks": [
    ],
  • "metadata": {
    },
  • "user": "dc1d2ecb8f00446496edf6edf3d813e7"
}

Get a list of team task action definitions

Endpoint returns all task action definitions that are accessible to the team specified in the URL, both team member created ones and system generated ones that are not editable.

query Parameters
public
string

Filter task action definitions by public state

required_object
string
Examples: required_object=form required_object=point required_object=path

Filter task action definitions by required_object

required_object
string

Filter task action definitions by device_type

displayable_name
string

Search for tasks by displayable name

slug
string

Search for tasks by slug

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "next": "string",
  • "page": 1,
  • "previous": "string",
  • "results": [
    ]
}

Create a new task action definition

Create a new task action definition that is only accessible for the current team

Request Body schema: application/json
displayable_name
required
string
slug
string <slug>
description
string or null
form
string or null <uuid>

Required if required_object is set to form

Note: this field is not expandable

required_object
required
string
Enum: "form" "point" "path"
user_input_needed
boolean
Default: true
wait_for_confirmation
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "displayable_name": "Move to Point",
  • "slug": "move_to_point",
  • "description": "string",
  • "form": "e2e5878f2ed4466792e514a8f396e271",
  • "required_object": "form",
  • "user_input_needed": true,
  • "wait_for_confirmation": true
}

Response samples

Content type
application/json
{
  • "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
  • "system_generated": false,
  • "displayable_name": "Move to Point",
  • "slug": "move_to_point",
  • "description": "string",
  • "form": "e2e5878f2ed4466792e514a8f396e271",
  • "required_object": "form",
  • "user_input_needed": true,
  • "wait_for_confirmation": true
}

Get a list of team Task Action Presets

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "next": "string",
  • "page": 1,
  • "previous": "string",
  • "results": [
    ]
}

Create a new Task Action Preset

Request Body schema: application/json
definition
required
string <uuid>
description
string
point
string or null <hex>

Note: this field is not expandable

form_values
object

Responses

Request samples

Content type
application/json
{
  • "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
  • "description": "string",
  • "point": null,
  • "form_values": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "320ac1c8a0d94c07a41ea4143a4b780a",
  • "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
  • "description": "string",
  • "point": null,
  • "form_values": {
    }
}

Get a list of team Task Presets

query Parameters
title
string

Filter task presets by title

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "next": "string",
  • "page": 1,
  • "previous": "string",
  • "results": [
    ]
}

Create a new Task Preset

Request Body schema: application/json
title
required
string <slug>
slug
string <slug>
required_vehicle_category
string <hex>
auto_confirmation
boolean
confirmation_methods
Array of strings
looped_task
boolean
required
Array of objects (task-preset_SubtaskPreset)
priority_level
integer

Responses

Request samples

Content type
application/json
{
  • "title": "Pick from Shelf 1",
  • "slug": "pick-from-shelf-1",
  • "required_vehicle_category": null,
  • "auto_confirmation": true,
  • "confirmation_methods": [
    ],
  • "looped_task": true,
  • "subtasks": [
    ],
  • "priority_level": 50
}

Response samples

Content type
application/json
{
  • "uuid": "20128c30066b4c6dbb1261d0c5387c11",
  • "title": "Pick from Shelf 1",
  • "slug": "pick-from-shelf-1",
  • "required_vehicle_category": null,
  • "auto_confirmation": true,
  • "confirmation_methods": [
    ],
  • "looped_task": true,
  • "subtasks": [
    ],
  • "metadata": {
    },
  • "priority_level": 50
}

Retrieve Task by UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "11495b9cca374e41a1cda9604169235b",
  • "number": "20220113_0543",
  • "status": "created",
  • "seen": true,
  • "priority_level": 50,
  • "auto_confirmation": true,
  • "confirmation_methods": [
    ],
  • "can_be_confirmed": true,
  • "can_be_relaunched": true,
  • "relaunched_from": "7c2a734c-6bd1-4710-9e0f-c8542192fe44",
  • "relaunched_task": "5f06ebe5-f11a-41db-8ce6-6788a157162f",
  • "vehicle": "49ced169d8f44808b0422cf5317d9e45",
  • "required_vehicle_category": "c2bfb3237b874e238a7efa727d8485f8",
  • "looped_task": true,
  • "abort_decision": 0,
  • "subtasks": [
    ],
  • "metadata": {
    }
}

Confirm current Subtask for Task by UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "11495b9cca374e41a1cda9604169235b",
  • "number": "20220113_0543",
  • "status": "created",
  • "seen": true,
  • "priority_level": 50,
  • "auto_confirmation": true,
  • "confirmation_methods": [
    ],
  • "can_be_confirmed": true,
  • "can_be_relaunched": true,
  • "relaunched_from": "7c2a734c-6bd1-4710-9e0f-c8542192fe44",
  • "relaunched_task": "5f06ebe5-f11a-41db-8ce6-6788a157162f",
  • "vehicle": "49ced169d8f44808b0422cf5317d9e45",
  • "required_vehicle_category": "c2bfb3237b874e238a7efa727d8485f8",
  • "looped_task": true,
  • "abort_decision": 0,
  • "subtasks": [
    ],
  • "metadata": {
    }
}

Relaunch or mark Task as seen by UUID

Request Body schema: application/json
number
string
priority_level
integer
auto_confirmation
boolean
confirmation_methods
Array of strings (ConfirmationMethodList)
Items Enum: "user" "auto" "workflow" "trigger"
vehicle
string <uuid>
required_vehicle_category
string <uuid>
looped_task
boolean
abort_decision
integer
required
Array of objects (tasks_Subtask)

Responses

Request samples

Content type
application/json
{
  • "number": "20220113_0543",
  • "priority_level": 50,
  • "auto_confirmation": true,
  • "confirmation_methods": [
    ],
  • "vehicle": "49ced169d8f44808b0422cf5317d9e45",
  • "required_vehicle_category": "c2bfb3237b874e238a7efa727d8485f8",
  • "looped_task": true,
  • "abort_decision": 0,
  • "subtasks": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "11495b9cca374e41a1cda9604169235b",
  • "number": "20220113_0543",
  • "status": "created",
  • "seen": true,
  • "priority_level": 50,
  • "auto_confirmation": true,
  • "confirmation_methods": [
    ],
  • "can_be_confirmed": true,
  • "can_be_relaunched": true,
  • "relaunched_from": "7c2a734c-6bd1-4710-9e0f-c8542192fe44",
  • "relaunched_task": "5f06ebe5-f11a-41db-8ce6-6788a157162f",
  • "vehicle": "49ced169d8f44808b0422cf5317d9e45",
  • "required_vehicle_category": "c2bfb3237b874e238a7efa727d8485f8",
  • "looped_task": true,
  • "abort_decision": 0,
  • "subtasks": [
    ],
  • "metadata": {
    }
}

Fail Task and the remaining Subtasks by UUID

Fail Task and the remaining Subtasks by UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "11495b9cca374e41a1cda9604169235b",
  • "number": "20220113_0543",
  • "status": "created",
  • "seen": true,
  • "priority_level": 50,
  • "auto_confirmation": true,
  • "confirmation_methods": [
    ],
  • "can_be_confirmed": true,
  • "can_be_relaunched": true,
  • "relaunched_from": "7c2a734c-6bd1-4710-9e0f-c8542192fe44",
  • "relaunched_task": "5f06ebe5-f11a-41db-8ce6-6788a157162f",
  • "vehicle": "49ced169d8f44808b0422cf5317d9e45",
  • "required_vehicle_category": "c2bfb3237b874e238a7efa727d8485f8",
  • "looped_task": true,
  • "abort_decision": 0,
  • "subtasks": [
    ],
  • "metadata": {
    }
}

Retrieve Task Preset by UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "20128c30066b4c6dbb1261d0c5387c11",
  • "title": "Pick from Shelf 1",
  • "slug": "pick-from-shelf-1",
  • "required_vehicle_category": null,
  • "auto_confirmation": true,
  • "confirmation_methods": [
    ],
  • "looped_task": true,
  • "subtasks": [
    ],
  • "metadata": {
    },
  • "priority_level": 50
}

Update Task Preset by UUID

Request Body schema: application/json
title
required
string <slug>
slug
string <slug>
required_vehicle_category
string <hex>
auto_confirmation
boolean
confirmation_methods
Array of strings
looped_task
boolean
required
Array of objects (task-preset_SubtaskPreset)
priority_level
integer

Responses

Request samples

Content type
application/json
{
  • "title": "Pick from Shelf 1",
  • "slug": "pick-from-shelf-1",
  • "required_vehicle_category": null,
  • "auto_confirmation": true,
  • "confirmation_methods": [
    ],
  • "looped_task": true,
  • "subtasks": [
    ],
  • "priority_level": 50
}

Response samples

Content type
application/json
{
  • "uuid": "20128c30066b4c6dbb1261d0c5387c11",
  • "title": "Pick from Shelf 1",
  • "slug": "pick-from-shelf-1",
  • "required_vehicle_category": null,
  • "auto_confirmation": true,
  • "confirmation_methods": [
    ],
  • "looped_task": true,
  • "subtasks": [
    ],
  • "metadata": {
    },
  • "priority_level": 50
}

Delete Task Preset by UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "e2e5878f2ed4466792e514a8f396e271",
  • "slug": "slug",
  • "deleted": true
}

Retrieve Task Action Definition by UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
  • "system_generated": false,
  • "displayable_name": "Move to Point",
  • "slug": "move_to_point",
  • "description": "string",
  • "form": "e2e5878f2ed4466792e514a8f396e271",
  • "required_object": "form",
  • "user_input_needed": true,
  • "wait_for_confirmation": true
}

Update Task Action Definition by UUID

Request Body schema: application/json
displayable_name
required
string
slug
string <slug>
description
string or null
form
string or null <uuid>

Required if required_object is set to form

Note: this field is not expandable

required_object
required
string
Enum: "form" "point" "path"
user_input_needed
boolean
Default: true
wait_for_confirmation
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "displayable_name": "Move to Point",
  • "slug": "move_to_point",
  • "description": "string",
  • "form": "e2e5878f2ed4466792e514a8f396e271",
  • "required_object": "form",
  • "user_input_needed": true,
  • "wait_for_confirmation": true
}

Response samples

Content type
application/json
{
  • "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
  • "system_generated": false,
  • "displayable_name": "Move to Point",
  • "slug": "move_to_point",
  • "description": "string",
  • "form": "e2e5878f2ed4466792e514a8f396e271",
  • "required_object": "form",
  • "user_input_needed": true,
  • "wait_for_confirmation": true
}

Delete Task Action Definition by UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "e2e5878f2ed4466792e514a8f396e271",
  • "slug": "slug",
  • "deleted": true
}

Retrieve Task Action Preset by UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "320ac1c8a0d94c07a41ea4143a4b780a",
  • "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
  • "description": "string",
  • "point": null,
  • "form_values": {
    }
}

Update Task Action Preset by UUID

Request Body schema: application/json
definition
required
string <uuid>
description
string
point
string or null <hex>

Note: this field is not expandable

form_values
object

Responses

Request samples

Content type
application/json
{
  • "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
  • "description": "string",
  • "point": null,
  • "form_values": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "320ac1c8a0d94c07a41ea4143a4b780a",
  • "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
  • "description": "string",
  • "point": null,
  • "form_values": {
    }
}

Delete Task Action Preset by UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "e2e5878f2ed4466792e514a8f396e271",
  • "slug": "slug",
  • "deleted": true
}

Update the abort decision status

Responses

Response samples

Content type
application/json
{
  • "uuid": "11495b9cca374e41a1cda9604169235b",
  • "number": "20220113_0543",
  • "status": "created",
  • "seen": true,
  • "priority_level": 50,
  • "auto_confirmation": true,
  • "confirmation_methods": [
    ],
  • "can_be_confirmed": true,
  • "can_be_relaunched": true,
  • "relaunched_from": "7c2a734c-6bd1-4710-9e0f-c8542192fe44",
  • "relaunched_task": "5f06ebe5-f11a-41db-8ce6-6788a157162f",
  • "vehicle": "49ced169d8f44808b0422cf5317d9e45",
  • "required_vehicle_category": "c2bfb3237b874e238a7efa727d8485f8",
  • "looped_task": true,
  • "abort_decision": 0,
  • "subtasks": [
    ],
  • "metadata": {
    }
}

Teams

List all teams for the current user

List all teams for the current user

Responses

Response samples

Content type
application/json
[]

Return team by identifier

Return team by identifier

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{}

Update team

Update team

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
membership_type
string
Enum: "member" "admin" "maintainer" "owner" "observer"
object (User)

Responses

Request samples

Content type
application/json
{
  • "membership_type": "member",
  • "user": {
    }
}

Response samples

Content type
application/json
{}

Delete team

Delete team

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{
  • "deleted": true,
  • "slug": "string",
  • "uuid": "8946d2e1366043dd919db31bd8a54833"
}

Retrieve Team Settings

Retrieve Team Settings

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{
  • "optimize_indoor_maps": true,
  • "path_rerouting": true,
  • "collision_detection_threshold": 1,
  • "safety_distance_threshold_in_m": 0.5,
  • "safety_distance_threshold": 500,
  • "receive_trajectory_from_robots": false
}

Update Team Settings

Update Team Settings

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
optimize_indoor_maps
boolean
path_rerouting
boolean
collision_detection_threshold
decimal
safety_distance_threshold_in_m
decimal
safety_distance_threshold
integer
receive_trajectory_from_robots
boolean

Responses

Request samples

Content type
application/json
{
  • "optimize_indoor_maps": true,
  • "path_rerouting": true,
  • "collision_detection_threshold": 1,
  • "safety_distance_threshold_in_m": 0.5,
  • "safety_distance_threshold": 500,
  • "receive_trajectory_from_robots": false
}

Response samples

Content type
application/json
{
  • "optimize_indoor_maps": true,
  • "path_rerouting": true,
  • "collision_detection_threshold": 1,
  • "safety_distance_threshold_in_m": 0.5,
  • "safety_distance_threshold": 500,
  • "receive_trajectory_from_robots": false
}

Return team status

Return team status

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{
  • "recalculations_needed": true,
  • "calculations_done": true,
  • "user_input_required": true,
  • "points_exist": true
}

Return a list of team members

Return a list of team members

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{}

Retrieve Team-Settings key

Retrieve Team-Settings key

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "key": "499c2c9e256609eb3ef068e25869c97998b9a67f"
}

Regenerate Team-Settings key

Regenerate Team-Settings key

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "key": "499c2c9e256609eb3ef068e25869c97998b9a67f"
}

Get a list of MQTT message types

Retrieve a list of possible messages types for MQTT communications. These messages are originating from FMS internals and sent to your vehicles using MQTT in VDA5050 JSON message type.

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{
  • "message_types": {
    }
}

Build and send sample message via MQTT

Debug your communications by sending a sample message of specified type to your robot.

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
message_type
string
Enum: "docking_routine_finalize_request" "docking_routine_request" "drop_command" "path_rerouting" "slow_down" "task" "topic_init"
vehicle
string <hex>

UUID of the vehicle to send the message to

Responses

Request samples

Content type
application/json
{
  • "message_type": "docking_routine_finalize_request",
  • "vehicle": "49ced169d8f44808b0422cf5317d9e45"
}

Response samples

Content type
application/json
{
  • "detail": "OK"
}

Trigger an emergency stop

This endpoint is used to trigger an emergency stop on a team. This will stop all the robots in the team and will prevent them from moving until the emergency stop is reset.

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{
  • "recalculations_needed": true,
  • "calculations_done": true,
  • "user_input_required": true,
  • "points_exist": true
}

Reset an emergency stop

This endpoint is used to reset an emergency stop on a team. This will allow to assign new missions to the robots.

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{
  • "recalculations_needed": true,
  • "calculations_done": true,
  • "user_input_required": true,
  • "points_exist": true
}

Notifications

List notifications

Get a list of all notations

Responses

Response samples

Content type
application/json
{
  • "notifications": [
    ]
}

Mark notifications as read

Mark all current notifications as read

Responses

Response samples

Content type
application/json
{
  • "notifications": [
    ]
}

Delete notifications

Deletes only notifications with read status

Responses

ROS Setups

This part of documentation describes the functionality of setups that help teams organize their fleets into smaller groups

Retrieve ROS Setup by UUID

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "4b141de094a94e4a97d809c5522d7d6c",
  • "verbose_name": "Setup 1",
  • "pin": "HKGEG",
  • "created_at": "2022-07-22T10:40:21.224184+02:00",
  • "used": "2019-08-24T14:15:22Z",
  • "mqtt_id": "meili-agent-fff53e61-005c-4116-9c5c-cde6c501ee83",
  • "ros_logs_frequency": 0,
  • "vehicles": [
    ]
}

Update ROS Setup by UUID

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Request Body schema: application/json
verbose_name
required
string
ros_logs_frequency
integer or null
Array of objects (SetupVehicleProfile)

Responses

Request samples

Content type
application/json
{
  • "verbose_name": "Setup 1",
  • "ros_logs_frequency": 0,
  • "vehicles": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "4b141de094a94e4a97d809c5522d7d6c",
  • "verbose_name": "Setup 1",
  • "pin": "HKGEG",
  • "created_at": "2022-07-22T10:40:21.224184+02:00",
  • "used": "2019-08-24T14:15:22Z",
  • "mqtt_id": "meili-agent-fff53e61-005c-4116-9c5c-cde6c501ee83",
  • "ros_logs_frequency": 0,
  • "vehicles": [
    ]
}

Delete ROS Setup by UUID

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "deleted": true,
  • "uuid": "49ced169d8f44808b0422cf5317d9e45"
}

Retrieve ROS setup token

Retrieve ROS setup token

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "token": "53df22f947755e60b9a9f2f15baa46cf033dd3a1"
}

Regenerate ROS setup token

Regenerate ROS setup token

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "token": "53df22f947755e60b9a9f2f15baa46cf033dd3a1"
}

Retrieve a list of ROS setups belonging to a team

path Parameters
required
string or string

UUID or SLUG of the target resource

query Parameters
used
string
Enum: true false

Filter setups by used state

verbose_name
string

Filter setups by verbose name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new ROS setup

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
verbose_name
required
string
ros_logs_frequency
integer or null
Array of objects (SetupVehicleProfile)

Responses

Request samples

Content type
application/json
{
  • "verbose_name": "Setup 1",
  • "ros_logs_frequency": 0,
  • "vehicles": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Manufacturers

If manufacturer is not marked as public, to see this manufacturer other organizations will have to receive explicit visibility rights

Get manufacturer given access

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
{
  • "organization": "287c54aeaa534b71bc2cfd7762018ba4",
  • "site": "app.meilirobots.com"
}

Grant access for an organization

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
organization
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "organization": "287c54aeaa534b71bc2cfd7762018ba4"
}

Response samples

Content type
application/json
{
  • "organization": "287c54aeaa534b71bc2cfd7762018ba4",
  • "site": "app.meilirobots.com"
}

Revoke access to manufacturer

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
organization
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "organization": "287c54aeaa534b71bc2cfd7762018ba4"
}

Return a list of manufacturers

Return a list of manufacturers

path Parameters
required
string or string

UUID or SLUG of the target resource

query Parameters
title
string

Title of the manufacturer

slug
string

Slug of the manufacturer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get manufacturer accesses given for the vehicle

Usually manufacturers cannot access most vehicle data, however if access is given and is valid, they will be able to see full details and edit them

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{}

Create a new access for manufacturer

Usually manufacturers cannot access most vehicle data, however if access is given and is valid, they will be able to see full details and edit them

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Request Body schema: application/json
duration
required
integer
Default: 1

Time defined in days

Responses

Request samples

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

Response samples

Content type
application/json
{}

Delete vehicle manufacturer access

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

General

Get a list of available timezones

Responses

Response samples

Content type
application/json
[
  • "Africa/Abidjan",
  • "Africa/Accra",
  • "Africa/Addis_Ababa",
  • "Africa/Algiers",
  • "Africa/Asmara",
  • "Africa/Asmera",
  • "Africa/Bamako",
  • "Africa/Bangui",
  • "Africa/Banjul",
  • "Africa/Bissau",
  • "Africa/Blantyre",
  • "Africa/Brazzaville",
  • "Africa/Bujumbura",
  • "Africa/Cairo",
  • "Africa/Casablanca",
  • "Africa/Ceuta",
  • "Africa/Conakry",
  • "Africa/Dakar",
  • "Africa/Dar_es_Salaam",
  • "Africa/Djibouti",
  • "Africa/Douala",
  • "Africa/El_Aaiun",
  • "Africa/Freetown",
  • "Africa/Gaborone",
  • "Africa/Harare",
  • "Africa/Johannesburg",
  • "Africa/Juba",
  • "Africa/Kampala",
  • "Africa/Khartoum",
  • "Africa/Kigali",
  • "Africa/Kinshasa",
  • "Africa/Lagos",
  • "Africa/Libreville",
  • "Africa/Lome",
  • "Africa/Luanda",
  • "Africa/Lubumbashi",
  • "Africa/Lusaka",
  • "Africa/Malabo",
  • "Africa/Maputo",
  • "Africa/Maseru",
  • "Africa/Mbabane",
  • "Africa/Mogadishu",
  • "Africa/Monrovia",
  • "Africa/Nairobi",
  • "Africa/Ndjamena",
  • "Africa/Niamey",
  • "Africa/Nouakchott",
  • "Africa/Ouagadougou",
  • "Africa/Porto-Novo",
  • "Africa/Sao_Tome",
  • "Africa/Timbuktu",
  • "Africa/Tripoli",
  • "Africa/Tunis",
  • "Africa/Windhoek",
  • "America/Adak",
  • "America/Anchorage",
  • "America/Anguilla",
  • "America/Antigua",
  • "America/Araguaina",
  • "America/Argentina/Buenos_Aires",
  • "America/Argentina/Catamarca",
  • "America/Argentina/ComodRivadavia",
  • "America/Argentina/Cordoba",
  • "America/Argentina/Jujuy",
  • "America/Argentina/La_Rioja",
  • "America/Argentina/Mendoza",
  • "America/Argentina/Rio_Gallegos",
  • "America/Argentina/Salta",
  • "America/Argentina/San_Juan",
  • "America/Argentina/San_Luis",
  • "America/Argentina/Tucuman",
  • "America/Argentina/Ushuaia",
  • "America/Aruba",
  • "America/Asuncion",
  • "America/Atikokan",
  • "America/Atka",
  • "America/Bahia",
  • "America/Bahia_Banderas",
  • "America/Barbados",
  • "America/Belem",
  • "America/Belize",
  • "America/Blanc-Sablon",
  • "America/Boa_Vista",
  • "America/Bogota",
  • "America/Boise",
  • "America/Buenos_Aires",
  • "America/Cambridge_Bay",
  • "America/Campo_Grande",
  • "America/Cancun",
  • "America/Caracas",
  • "America/Catamarca",
  • "America/Cayenne",
  • "America/Cayman",
  • "America/Chicago",
  • "America/Chihuahua",
  • "America/Coral_Harbour",
  • "America/Cordoba",
  • "America/Costa_Rica",
  • "America/Creston",
  • "America/Cuiaba",
  • "America/Curacao",
  • "America/Danmarkshavn",
  • "America/Dawson",
  • "America/Dawson_Creek",
  • "America/Denver",
  • "America/Detroit",
  • "America/Dominica",
  • "America/Edmonton",
  • "America/Eirunepe",
  • "America/El_Salvador",
  • "America/Ensenada",
  • "America/Fort_Nelson",
  • "America/Fort_Wayne",
  • "America/Fortaleza",
  • "America/Glace_Bay",
  • "America/Godthab",
  • "America/Goose_Bay",
  • "America/Grand_Turk",
  • "America/Grenada",
  • "America/Guadeloupe",
  • "America/Guatemala",
  • "America/Guayaquil",
  • "America/Guyana",
  • "America/Halifax",
  • "America/Havana",
  • "America/Hermosillo",
  • "America/Indiana/Indianapolis",
  • "America/Indiana/Knox",
  • "America/Indiana/Marengo",
  • "America/Indiana/Petersburg",
  • "America/Indiana/Tell_City",
  • "America/Indiana/Vevay",
  • "America/Indiana/Vincennes",
  • "America/Indiana/Winamac",
  • "America/Indianapolis",
  • "America/Inuvik",
  • "America/Iqaluit",
  • "America/Jamaica",
  • "America/Jujuy",
  • "America/Juneau",
  • "America/Kentucky/Louisville",
  • "America/Kentucky/Monticello",
  • "America/Knox_IN",
  • "America/Kralendijk",
  • "America/La_Paz",
  • "America/Lima",
  • "America/Los_Angeles",
  • "America/Louisville",
  • "America/Lower_Princes",
  • "America/Maceio",
  • "America/Managua",
  • "America/Manaus",
  • "America/Marigot",
  • "America/Martinique",
  • "America/Matamoros",
  • "America/Mazatlan",
  • "America/Mendoza",
  • "America/Menominee",
  • "America/Merida",
  • "America/Metlakatla",
  • "America/Mexico_City",
  • "America/Miquelon",
  • "America/Moncton",
  • "America/Monterrey",
  • "America/Montevideo",
  • "America/Montreal",
  • "America/Montserrat",
  • "America/Nassau",
  • "America/New_York",
  • "America/Nipigon",
  • "America/Nome",
  • "America/Noronha",
  • "America/North_Dakota/Beulah",
  • "America/North_Dakota/Center",
  • "America/North_Dakota/New_Salem",
  • "America/Nuuk",
  • "America/Ojinaga",
  • "America/Panama",
  • "America/Pangnirtung",
  • "America/Paramaribo",
  • "America/Phoenix",
  • "America/Port-au-Prince",
  • "America/Port_of_Spain",
  • "America/Porto_Acre",
  • "America/Porto_Velho",
  • "America/Puerto_Rico",
  • "America/Punta_Arenas",
  • "America/Rainy_River",
  • "America/Rankin_Inlet",
  • "America/Recife",
  • "America/Regina",
  • "America/Resolute",
  • "America/Rio_Branco",
  • "America/Rosario",
  • "America/Santa_Isabel",
  • "America/Santarem",
  • "America/Santiago",
  • "America/Santo_Domingo",
  • "America/Sao_Paulo",
  • "America/Scoresbysund",
  • "America/Shiprock",
  • "America/Sitka",
  • "America/St_Barthelemy",
  • "America/St_Johns",
  • "America/St_Kitts",
  • "America/St_Lucia",
  • "America/St_Thomas",
  • "America/St_Vincent",
  • "America/Swift_Current",
  • "America/Tegucigalpa",
  • "America/Thule",
  • "America/Thunder_Bay",
  • "America/Tijuana",
  • "America/Toronto",
  • "America/Tortola",
  • "America/Vancouver",
  • "America/Virgin",
  • "America/Whitehorse",
  • "America/Winnipeg",
  • "America/Yakutat",
  • "America/Yellowknife",
  • "Antarctica/Casey",
  • "Antarctica/Davis",
  • "Antarctica/DumontDUrville",
  • "Antarctica/Macquarie",
  • "Antarctica/Mawson",
  • "Antarctica/McMurdo",
  • "Antarctica/Palmer",
  • "Antarctica/Rothera",
  • "Antarctica/South_Pole",
  • "Antarctica/Syowa",
  • "Antarctica/Troll",
  • "Antarctica/Vostok",
  • "Arctic/Longyearbyen",
  • "Asia/Aden",
  • "Asia/Almaty",
  • "Asia/Amman",
  • "Asia/Anadyr",
  • "Asia/Aqtau",
  • "Asia/Aqtobe",
  • "Asia/Ashgabat",
  • "Asia/Ashkhabad",
  • "Asia/Atyrau",
  • "Asia/Baghdad",
  • "Asia/Bahrain",
  • "Asia/Baku",
  • "Asia/Bangkok",
  • "Asia/Barnaul",
  • "Asia/Beirut",
  • "Asia/Bishkek",
  • "Asia/Brunei",
  • "Asia/Calcutta",
  • "Asia/Chita",
  • "Asia/Choibalsan",
  • "Asia/Chongqing",
  • "Asia/Chungking",
  • "Asia/Colombo",
  • "Asia/Dacca",
  • "Asia/Damascus",
  • "Asia/Dhaka",
  • "Asia/Dili",
  • "Asia/Dubai",
  • "Asia/Dushanbe",
  • "Asia/Famagusta",
  • "Asia/Gaza",
  • "Asia/Harbin",
  • "Asia/Hebron",
  • "Asia/Ho_Chi_Minh",
  • "Asia/Hong_Kong",
  • "Asia/Hovd",
  • "Asia/Irkutsk",
  • "Asia/Istanbul",
  • "Asia/Jakarta",
  • "Asia/Jayapura",
  • "Asia/Jerusalem",
  • "Asia/Kabul",
  • "Asia/Kamchatka",
  • "Asia/Karachi",
  • "Asia/Kashgar",
  • "Asia/Kathmandu",
  • "Asia/Katmandu",
  • "Asia/Khandyga",
  • "Asia/Kolkata",
  • "Asia/Krasnoyarsk",
  • "Asia/Kuala_Lumpur",
  • "Asia/Kuching",
  • "Asia/Kuwait",
  • "Asia/Macao",
  • "Asia/Macau",
  • "Asia/Magadan",
  • "Asia/Makassar",
  • "Asia/Manila",
  • "Asia/Muscat",
  • "Asia/Nicosia",
  • "Asia/Novokuznetsk",
  • "Asia/Novosibirsk",
  • "Asia/Omsk",
  • "Asia/Oral",
  • "Asia/Phnom_Penh",
  • "Asia/Pontianak",
  • "Asia/Pyongyang",
  • "Asia/Qatar",
  • "Asia/Qostanay",
  • "Asia/Qyzylorda",
  • "Asia/Rangoon",
  • "Asia/Riyadh",
  • "Asia/Saigon",
  • "Asia/Sakhalin",
  • "Asia/Samarkand",
  • "Asia/Seoul",
  • "Asia/Shanghai",
  • "Asia/Singapore",
  • "Asia/Srednekolymsk",
  • "Asia/Taipei",
  • "Asia/Tashkent",
  • "Asia/Tbilisi",
  • "Asia/Tehran",
  • "Asia/Tel_Aviv",
  • "Asia/Thimbu",
  • "Asia/Thimphu",
  • "Asia/Tokyo",
  • "Asia/Tomsk",
  • "Asia/Ujung_Pandang",
  • "Asia/Ulaanbaatar",
  • "Asia/Ulan_Bator",
  • "Asia/Urumqi",
  • "Asia/Ust-Nera",
  • "Asia/Vientiane",
  • "Asia/Vladivostok",
  • "Asia/Yakutsk",
  • "Asia/Yangon",
  • "Asia/Yekaterinburg",
  • "Asia/Yerevan",
  • "Atlantic/Azores",
  • "Atlantic/Bermuda",
  • "Atlantic/Canary",
  • "Atlantic/Cape_Verde",
  • "Atlantic/Faeroe",
  • "Atlantic/Faroe",
  • "Atlantic/Jan_Mayen",
  • "Atlantic/Madeira",
  • "Atlantic/Reykjavik",
  • "Atlantic/South_Georgia",
  • "Atlantic/St_Helena",
  • "Atlantic/Stanley",
  • "Australia/ACT",
  • "Australia/Adelaide",
  • "Australia/Brisbane",
  • "Australia/Broken_Hill",
  • "Australia/Canberra",
  • "Australia/Currie",
  • "Australia/Darwin",
  • "Australia/Eucla",
  • "Australia/Hobart",
  • "Australia/LHI",
  • "Australia/Lindeman",
  • "Australia/Lord_Howe",
  • "Australia/Melbourne",
  • "Australia/NSW",
  • "Australia/North",
  • "Australia/Perth",
  • "Australia/Queensland",
  • "Australia/South",
  • "Australia/Sydney",
  • "Australia/Tasmania",
  • "Australia/Victoria",
  • "Australia/West",
  • "Australia/Yancowinna",
  • "Brazil/Acre",
  • "Brazil/DeNoronha",
  • "Brazil/East",
  • "Brazil/West",
  • "CET",
  • "CST6CDT",
  • "Canada/Atlantic",
  • "Canada/Central",
  • "Canada/Eastern",
  • "Canada/Mountain",
  • "Canada/Newfoundland",
  • "Canada/Pacific",
  • "Canada/Saskatchewan",
  • "Canada/Yukon",
  • "Chile/Continental",
  • "Chile/EasterIsland",
  • "Cuba",
  • "EET",
  • "EST",
  • "EST5EDT",
  • "Egypt",
  • "Eire",
  • "Etc/GMT",
  • "Etc/GMT+0",
  • "Etc/GMT+1",
  • "Etc/GMT+10",
  • "Etc/GMT+11",
  • "Etc/GMT+12",
  • "Etc/GMT+2",
  • "Etc/GMT+3",
  • "Etc/GMT+4",
  • "Etc/GMT+5",
  • "Etc/GMT+6",
  • "Etc/GMT+7",
  • "Etc/GMT+8",
  • "Etc/GMT+9",
  • "Etc/GMT-0",
  • "Etc/GMT-1",
  • "Etc/GMT-10",
  • "Etc/GMT-11",
  • "Etc/GMT-12",
  • "Etc/GMT-13",
  • "Etc/GMT-14",
  • "Etc/GMT-2",
  • "Etc/GMT-3",
  • "Etc/GMT-4",
  • "Etc/GMT-5",
  • "Etc/GMT-6",
  • "Etc/GMT-7",
  • "Etc/GMT-8",
  • "Etc/GMT-9",
  • "Etc/GMT0",
  • "Etc/Greenwich",
  • "Etc/UCT",
  • "Etc/UTC",
  • "Etc/Universal",
  • "Etc/Zulu",
  • "Europe/Amsterdam",
  • "Europe/Andorra",
  • "Europe/Astrakhan",
  • "Europe/Athens",
  • "Europe/Belfast",
  • "Europe/Belgrade",
  • "Europe/Berlin",
  • "Europe/Bratislava",
  • "Europe/Brussels",
  • "Europe/Bucharest",
  • "Europe/Budapest",
  • "Europe/Busingen",
  • "Europe/Chisinau",
  • "Europe/Copenhagen",
  • "Europe/Dublin",
  • "Europe/Gibraltar",
  • "Europe/Guernsey",
  • "Europe/Helsinki",
  • "Europe/Isle_of_Man",
  • "Europe/Istanbul",
  • "Europe/Jersey",
  • "Europe/Kaliningrad",
  • "Europe/Kiev",
  • "Europe/Kirov",
  • "Europe/Lisbon",
  • "Europe/Ljubljana",
  • "Europe/London",
  • "Europe/Luxembourg",
  • "Europe/Madrid",
  • "Europe/Malta",
  • "Europe/Mariehamn",
  • "Europe/Minsk",
  • "Europe/Monaco",
  • "Europe/Moscow",
  • "Europe/Nicosia",
  • "Europe/Oslo",
  • "Europe/Paris",
  • "Europe/Podgorica",
  • "Europe/Prague",
  • "Europe/Riga",
  • "Europe/Rome",
  • "Europe/Samara",
  • "Europe/San_Marino",
  • "Europe/Sarajevo",
  • "Europe/Saratov",
  • "Europe/Simferopol",
  • "Europe/Skopje",
  • "Europe/Sofia",
  • "Europe/Stockholm",
  • "Europe/Tallinn",
  • "Europe/Tirane",
  • "Europe/Tiraspol",
  • "Europe/Ulyanovsk",
  • "Europe/Uzhgorod",
  • "Europe/Vaduz",
  • "Europe/Vatican",
  • "Europe/Vienna",
  • "Europe/Vilnius",
  • "Europe/Volgograd",
  • "Europe/Warsaw",
  • "Europe/Zagreb",
  • "Europe/Zaporozhye",
  • "Europe/Zurich",
  • "GB",
  • "GB-Eire",
  • "GMT",
  • "GMT+0",
  • "GMT-0",
  • "GMT0",
  • "Greenwich",
  • "HST",
  • "Hongkong",
  • "Iceland",
  • "Indian/Antananarivo",
  • "Indian/Chagos",
  • "Indian/Christmas",
  • "Indian/Cocos",
  • "Indian/Comoro",
  • "Indian/Kerguelen",
  • "Indian/Mahe",
  • "Indian/Maldives",
  • "Indian/Mauritius",
  • "Indian/Mayotte",
  • "Indian/Reunion",
  • "Iran",
  • "Israel",
  • "Jamaica",
  • "Japan",
  • "Kwajalein",
  • "Libya",
  • "MET",
  • "MST",
  • "MST7MDT",
  • "Mexico/BajaNorte",
  • "Mexico/BajaSur",
  • "Mexico/General",
  • "NZ",
  • "NZ-CHAT",
  • "Navajo",
  • "PRC",
  • "PST8PDT",
  • "Pacific/Apia",
  • "Pacific/Auckland",
  • "Pacific/Bougainville",
  • "Pacific/Chatham",
  • "Pacific/Chuuk",
  • "Pacific/Easter",
  • "Pacific/Efate",
  • "Pacific/Enderbury",
  • "Pacific/Fakaofo",
  • "Pacific/Fiji",
  • "Pacific/Funafuti",
  • "Pacific/Galapagos",
  • "Pacific/Gambier",
  • "Pacific/Guadalcanal",
  • "Pacific/Guam",
  • "Pacific/Honolulu",
  • "Pacific/Johnston",
  • "Pacific/Kanton",
  • "Pacific/Kiritimati",
  • "Pacific/Kosrae",
  • "Pacific/Kwajalein",
  • "Pacific/Majuro",
  • "Pacific/Marquesas",
  • "Pacific/Midway",
  • "Pacific/Nauru",
  • "Pacific/Niue",
  • "Pacific/Norfolk",
  • "Pacific/Noumea",
  • "Pacific/Pago_Pago",
  • "Pacific/Palau",
  • "Pacific/Pitcairn",
  • "Pacific/Pohnpei",
  • "Pacific/Ponape",
  • "Pacific/Port_Moresby",
  • "Pacific/Rarotonga",
  • "Pacific/Saipan",
  • "Pacific/Samoa",
  • "Pacific/Tahiti",
  • "Pacific/Tarawa",
  • "Pacific/Tongatapu",
  • "Pacific/Truk",
  • "Pacific/Wake",
  • "Pacific/Wallis",
  • "Pacific/Yap",
  • "Poland",
  • "Portugal",
  • "ROC",
  • "ROK",
  • "Singapore",
  • "Turkey",
  • "UCT",
  • "US/Alaska",
  • "US/Aleutian",
  • "US/Arizona",
  • "US/Central",
  • "US/East-Indiana",
  • "US/Eastern",
  • "US/Hawaii",
  • "US/Indiana-Starke",
  • "US/Michigan",
  • "US/Mountain",
  • "US/Pacific",
  • "US/Samoa",
  • "UTC",
  • "Universal",
  • "W-SU",
  • "WET",
  • "Zulu"
]

Websockets

This section of our API documentation will document everything related to websocket communication

How we structure this part?

OpenAPI does not come with Websocket capabilities out of the box, therefore this is the part where we took the liberty to improvise and make it our own.

All GET requests are the data received from websocket, post data that is sent to websocket

Retrieve messages from fleet websocket

Responses

Response samples

Content type
application/json
Example
{
  • "type": "task",
  • "vehicle": "49ced169d8f44808b0422cf5317d9e45",
  • "data": {
    }
}

Send messages to fleet websocket

Request Body schema: application/json
One of
event
required
string
Value: "register"
vehicles
required
Array of strings <uuid>

Request samples

Content type
application/json
Example
{
  • "event": "register",
  • "vehicles": [
    ]
}

Webhooks

Use webhooks to get notified when a new event has occurred on the server.

Create a webhook for the organization

Create a webhook for the organization

Request Body schema: application/json
url
required
string
scope
string
active
boolean
note
string
Array of objects
action_list
required
Array of strings
Items Enum: "vehicle.connected" "vehicle.disconnected" "task.started" "task.completed" "task.stuck" "task.failed" "task.timeout" "task.disconnected" "fleet.connected" "fleet.disconnected"

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "uuid": "17fdb48466104825b800d791c6a813d7",
  • "url": "https://webhook.site/b8dbf3df-b840-4a9b-931f-cad77a81b4fb",
  • "scope": "organization",
  • "active": true,
  • "note": "This is a note",
  • "headers": [
    ],
  • "action_list": [
    ]
}

List webhooks for the organization

List webhooks for the organization

path Parameters
required
string or string

UUID or SLUG of the target resource

query Parameters
ordering
string
Enum: "created_at" "team" "url" "scope" "active"

Order objects by field To specify descending order, prefix the field name with a minus sign ("-"). Example: To order by "created_at" in descending order, use "-created_at".

team
string

Filter webhooks by team (team slug or title)

url
string

Filter webhooks by url

scope
string

Filter webhooks by scope

active
string

Filter webhooks by active status (true or false)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a webhook for the team

Create a webhook for the team

Request Body schema: application/json
url
required
string
scope
string
active
boolean
note
string
Array of objects
action_list
required
Array of strings
Items Enum: "vehicle.connected" "vehicle.disconnected" "task.started" "task.completed" "task.stuck" "task.failed" "task.timeout" "task.disconnected" "fleet.connected" "fleet.disconnected"

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "uuid": "17fdb48466104825b800d791c6a813d7",
  • "url": "https://webhook.site/b8dbf3df-b840-4a9b-931f-cad77a81b4fb",
  • "scope": "organization",
  • "active": true,
  • "note": "This is a note",
  • "headers": [
    ],
  • "action_list": [
    ]
}

List webhooks for the team

List webhooks for the team

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a webhook

Get a webhook

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "17fdb48466104825b800d791c6a813d7",
  • "url": "https://webhook.site/b8dbf3df-b840-4a9b-931f-cad77a81b4fb",
  • "scope": "organization",
  • "active": true,
  • "note": "This is a note",
  • "headers": [
    ],
  • "action_list": [
    ]
}

Update a webhook

When updating, only actions in actions_list will be set.

Omit the action_list parameter if you want to keep the current actions.

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Request Body schema: application/json
url
required
string
scope
string
active
boolean
note
string
Array of objects
action_list
required
Array of strings
Items Enum: "vehicle.connected" "vehicle.disconnected" "task.started" "task.completed" "task.stuck" "task.failed" "task.timeout" "task.disconnected" "fleet.connected" "fleet.disconnected"

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "uuid": "17fdb48466104825b800d791c6a813d7",
  • "url": "https://webhook.site/b8dbf3df-b840-4a9b-931f-cad77a81b4fb",
  • "scope": "organization",
  • "active": true,
  • "note": "This is a note",
  • "headers": [
    ],
  • "action_list": [
    ]
}

Delete a webhook

Delete a webhook

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "deleted": true,
  • "uuid": "123456781234123412341234567890ab"
}

Activate deactivated webhook

Activate deactivated webhook

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "17fdb48466104825b800d791c6a813d7",
  • "url": "https://webhook.site/b8dbf3df-b840-4a9b-931f-cad77a81b4fb",
  • "scope": "organization",
  • "active": true,
  • "note": "This is a note",
  • "headers": [
    ],
  • "action_list": [
    ]
}

Triggers

Return a list of team triggers

Return a list of team triggers

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new trigger for the team

Create a new trigger for the team

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
verbose_name
required
string
url
string <url>
use_http
boolean

If selected, it will allow triggering actions via the HTTP URL provided

use_mqtt
boolean

If selected, it will allow triggering actions to the MQTT topic

point
string <uuid>
use_token_authentication
boolean

If selected, it will require to pass token via X-MEILI-TRIGGER-TOKEN HTTP header

use_ip_authentication
boolean

If selected, will only allow triggering actions for request coming from the whitelisted IPs

ip_whitelist
Array of strings
action
string
Enum: "location_confirm" "location_fail" "task_launch"

Responses

Request samples

Content type
application/json
{
  • "verbose_name": "Production line confirmation trigger",
  • "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
  • "use_http": true,
  • "use_mqtt": false,
  • "point": "36ee0ac1e01045758b52cef09451e908",
  • "use_token_authentication": false,
  • "use_ip_authentication": false,
  • "ip_whitelist": [
    ],
  • "action": "location_confirm"
}

Response samples

Content type
application/json
{
  • "uuid": "ffbee424bcd24e98847a257f8bb81ab3",
  • "verbose_name": "Production line confirmation trigger",
  • "token": "4c68a5d45c3eef408ac5a297c4682ad7429f3f17",
  • "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
  • "use_http": true,
  • "use_mqtt": false,
  • "point": "36ee0ac1e01045758b52cef09451e908",
  • "mqtt_id": "meili-trigger-c6650d45-5972-4bfd-9f22-5cb6cfd5cd4f",
  • "use_token_authentication": false,
  • "use_ip_authentication": false,
  • "ip_whitelist": [
    ],
  • "action": "location_confirm"
}

Return trigger

Return trigger

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "ffbee424bcd24e98847a257f8bb81ab3",
  • "verbose_name": "Production line confirmation trigger",
  • "token": "4c68a5d45c3eef408ac5a297c4682ad7429f3f17",
  • "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
  • "use_http": true,
  • "use_mqtt": false,
  • "point": "36ee0ac1e01045758b52cef09451e908",
  • "mqtt_id": "meili-trigger-c6650d45-5972-4bfd-9f22-5cb6cfd5cd4f",
  • "use_token_authentication": false,
  • "use_ip_authentication": false,
  • "ip_whitelist": [
    ],
  • "action": "location_confirm"
}

Update trigger

Update trigger

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Request Body schema: application/json
verbose_name
required
string
url
string <url>
use_http
boolean

If selected, it will allow triggering actions via the HTTP URL provided

use_mqtt
boolean

If selected, it will allow triggering actions to the MQTT topic

point
string <uuid>
use_token_authentication
boolean

If selected, it will require to pass token via X-MEILI-TRIGGER-TOKEN HTTP header

use_ip_authentication
boolean

If selected, will only allow triggering actions for request coming from the whitelisted IPs

ip_whitelist
Array of strings
action
string
Enum: "location_confirm" "location_fail" "task_launch"

Responses

Request samples

Content type
application/json
{
  • "verbose_name": "Production line confirmation trigger",
  • "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
  • "use_http": true,
  • "use_mqtt": false,
  • "point": "36ee0ac1e01045758b52cef09451e908",
  • "use_token_authentication": false,
  • "use_ip_authentication": false,
  • "ip_whitelist": [
    ],
  • "action": "location_confirm"
}

Response samples

Content type
application/json
{
  • "uuid": "ffbee424bcd24e98847a257f8bb81ab3",
  • "verbose_name": "Production line confirmation trigger",
  • "token": "4c68a5d45c3eef408ac5a297c4682ad7429f3f17",
  • "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
  • "use_http": true,
  • "use_mqtt": false,
  • "point": "36ee0ac1e01045758b52cef09451e908",
  • "mqtt_id": "meili-trigger-c6650d45-5972-4bfd-9f22-5cb6cfd5cd4f",
  • "use_token_authentication": false,
  • "use_ip_authentication": false,
  • "ip_whitelist": [
    ],
  • "action": "location_confirm"
}

delete trigger

delete trigger

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "ffbee424bcd24e98847a257f8bb81ab3"
}

Execute trigger action

Execute trigger action

path Parameters
key
required
string

Key of the trigger

Responses

Workflows

Return a list of team triggers

Return a list of team triggers

path Parameters
required
string or string

UUID or SLUG of the target resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new trigger for the team

Create a new trigger for the team

path Parameters
required
string or string

UUID or SLUG of the target resource

Request Body schema: application/json
verbose_name
required
string
url
string <url>
use_http
boolean

If selected, it will allow triggering actions via the HTTP URL provided

use_mqtt
boolean

If selected, it will allow triggering actions to the MQTT topic

point
string <uuid>
use_token_authentication
boolean

If selected, it will require to pass token via X-MEILI-TRIGGER-TOKEN HTTP header

use_ip_authentication
boolean

If selected, will only allow triggering actions for request coming from the whitelisted IPs

ip_whitelist
Array of strings
action
string
Enum: "location_confirm" "location_fail" "task_launch"

Responses

Request samples

Content type
application/json
{
  • "verbose_name": "Production line confirmation trigger",
  • "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
  • "use_http": true,
  • "use_mqtt": false,
  • "point": "36ee0ac1e01045758b52cef09451e908",
  • "use_token_authentication": false,
  • "use_ip_authentication": false,
  • "ip_whitelist": [
    ],
  • "action": "location_confirm"
}

Response samples

Content type
application/json
{
  • "uuid": "ffbee424bcd24e98847a257f8bb81ab3",
  • "verbose_name": "Production line confirmation trigger",
  • "token": "4c68a5d45c3eef408ac5a297c4682ad7429f3f17",
  • "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
  • "use_http": true,
  • "use_mqtt": false,
  • "point": "36ee0ac1e01045758b52cef09451e908",
  • "mqtt_id": "meili-trigger-c6650d45-5972-4bfd-9f22-5cb6cfd5cd4f",
  • "use_token_authentication": false,
  • "use_ip_authentication": false,
  • "ip_whitelist": [
    ],
  • "action": "location_confirm"
}

Return trigger

Return trigger

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "ffbee424bcd24e98847a257f8bb81ab3",
  • "verbose_name": "Production line confirmation trigger",
  • "token": "4c68a5d45c3eef408ac5a297c4682ad7429f3f17",
  • "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
  • "use_http": true,
  • "use_mqtt": false,
  • "point": "36ee0ac1e01045758b52cef09451e908",
  • "mqtt_id": "meili-trigger-c6650d45-5972-4bfd-9f22-5cb6cfd5cd4f",
  • "use_token_authentication": false,
  • "use_ip_authentication": false,
  • "ip_whitelist": [
    ],
  • "action": "location_confirm"
}

Update trigger

Update trigger

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Request Body schema: application/json
verbose_name
required
string
url
string <url>
use_http
boolean

If selected, it will allow triggering actions via the HTTP URL provided

use_mqtt
boolean

If selected, it will allow triggering actions to the MQTT topic

point
string <uuid>
use_token_authentication
boolean

If selected, it will require to pass token via X-MEILI-TRIGGER-TOKEN HTTP header

use_ip_authentication
boolean

If selected, will only allow triggering actions for request coming from the whitelisted IPs

ip_whitelist
Array of strings
action
string
Enum: "location_confirm" "location_fail" "task_launch"

Responses

Request samples

Content type
application/json
{
  • "verbose_name": "Production line confirmation trigger",
  • "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
  • "use_http": true,
  • "use_mqtt": false,
  • "point": "36ee0ac1e01045758b52cef09451e908",
  • "use_token_authentication": false,
  • "use_ip_authentication": false,
  • "ip_whitelist": [
    ],
  • "action": "location_confirm"
}

Response samples

Content type
application/json
{
  • "uuid": "ffbee424bcd24e98847a257f8bb81ab3",
  • "verbose_name": "Production line confirmation trigger",
  • "token": "4c68a5d45c3eef408ac5a297c4682ad7429f3f17",
  • "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
  • "use_http": true,
  • "use_mqtt": false,
  • "point": "36ee0ac1e01045758b52cef09451e908",
  • "mqtt_id": "meili-trigger-c6650d45-5972-4bfd-9f22-5cb6cfd5cd4f",
  • "use_token_authentication": false,
  • "use_ip_authentication": false,
  • "ip_whitelist": [
    ],
  • "action": "location_confirm"
}

delete trigger

delete trigger

path Parameters
uuid
required
string <uuid>

UUID of the target resource

Responses

Response samples

Content type
application/json
{
  • "uuid": "ffbee424bcd24e98847a257f8bb81ab3"
}

Execute trigger action

Execute trigger action

path Parameters
key
required
string

Key of the trigger

Responses