Missions

All endpoints described in this section require a valid authentication token. Please refer to the Authentication section for details on how to obtain and use tokens.

Base URL: https://api.unleashlive.com

Create, manage, and retrieve flight missions. A mission defines a flight plan consisting of waypoints (route) that a drone follows during autonomous flight.

Endpoints

Create Mission

POST /v1/mission

Creates a new mission for the user’s team.

Request Body

Field	Type	Description
`name`	String	(required) Mission name
`route`	MissionPoint[]	Waypoints array (required unless using survey)
`description`	String	Mission description
`type`	String	Mission type (see Mission Type)
`heightMode`	String	Height mode (see Height Mode)
`speed`	Number	Flight speed

For the full mission point structure, see Mission Point.

Example Request

{
  "name": "test mission",
  "desc": "Sample-mission",
  "speed": 2,
  "route": [
    {
      "pole": "Pole1",
      "wo": "00800521567",
      "lat": -33.72577124,
      "lng": 151.18167339,
      "altitude": 163.144,
      "altEGM": 187.144,
      "si": "dist-3"
    },
    {
      "pole": "WP",
      "wo": "00800521567",
      "lat": -33.72577124,
      "lng": 151.18167339,
      "altitude": 171.144,
      "altEGM": 195.144,
      "si": "waypoint"
    }
  ]
}

Example Response

Returns the created Mission Object.

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "test mission",
  "description": "Sample-mission",
  "speed": 2,
  "type": "waypoint",
  "teamId": "teamId1",
  "companyId": "companyId1",
  "ownerId": "userId1",
  "createdAt": 1709654015526,
  "updatedAt": 1709654015526,
  "route": [
    {
      "pole": "Pole1",
      "lat": -33.72577124,
      "lng": 151.18167339,
      "altitude": 163.144,
      "altEGM": 187.144
    }
  ]
}

For a full working example, see upload-mission.js. Sample mission files are available in the mission/assets directory.

List Missions

GET /v1/mission

Lists missions for the user’s team (inferred from the authentication token).

With query parameters — returns a paginated response.
Without query parameters — returns all missions (non-paginated).

Query Parameters

Parameter	Type	Description
`filter`	String	Filter by mission type (see Mission Type)
`dateFrom`	String	Return missions created after this date
`dateTo`	String	Return missions created before this date
`limit`	Integer	Maximum number of items per page
`nextToken`	String	Pagination token from a previous response

Example Request

GET /v1/mission?filter=waypoint&limit=10

Paginated Response

Returns an object with items (array of Mission Objects) and nextToken.

{
  "items": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Powerline Inspection Route A",
      "type": "waypoint",
      "speed": 5,
      "distance": 1200,
      "time": 480,
      "createdAt": 1709654015526,
      "updatedAt": 1709654015526
    }
  ],
  "nextToken": "eyJwayI6InRlYW1JZDEi..."
}

Non-Paginated Response

Returns an array of Mission Objects.

[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Powerline Inspection Route A",
    "type": "waypoint"
  }
]

Get Mission

GET /v1/mission/{id}

Retrieves a single mission by its ID.

Path Parameters

Parameter	Type	Description
`id`	String	(required) The mission ID

Example Request

GET /v1/mission/a1b2c3d4-e5f6-7890-abcd-ef1234567890

Example Response

Returns the full Mission Object including the route array.

Update Mission

PATCH /v1/mission/{id}

Updates an existing mission. Only the fields provided in the request body will be updated.

Path Parameters

Parameter	Type	Description
`id`	String	(required) The mission ID

Request Body

Any field from the Mission Object can be included. Only provided fields are updated.

Example Request

{
  "name": "Updated Mission Name",
  "speed": 8
}

Delete Mission

DELETE /v1/mission/{id}

Deletes a mission by its ID.

Path Parameters

Parameter	Type	Description
`id`	String	(required) The mission ID

Example Request

DELETE /v1/mission/a1b2c3d4-e5f6-7890-abcd-ef1234567890

Example Response

Returns the deleted Mission Object.

Reference

Mission Object

Field	Type	Description
`id`	String	Unique mission identifier (auto-generated)
`name`	String	Mission name (required)
`description`	String	Mission description
`type`	String	Mission type (see Mission Type)
`heightMode`	String	Height reference mode (see Height Mode)
`route`	MissionPoint[]	Array of waypoints (see Mission Point)
`speed`	Number	Flight speed
`distance`	Number	Total mission distance (meters)
`time`	Number	Estimated flight time
`lastFlight`	Number	Timestamp of the last flight using this mission
`isImported`	Boolean	Whether the mission was imported from external source
`isSmartInspect`	Boolean	Whether the mission uses smart inspect mode
`teamId`	String	Team ID (auto-set from authentication)
`companyId`	String	Company ID (auto-set from authentication)
`ownerId`	String	Owner/creator identifier (auto-set)
`createdAt`	Number	Creation timestamp (Unix ms)
`updatedAt`	Number	Last update timestamp (Unix ms)

Mission Point

Each waypoint in the route array has the following structure:

Field	Type	Description
`lat`	Number	(required) Latitude
`lng`	Number	(required) Longitude
`altitude`	Number	Altitude — relative to start point
`altitudeWGS`	Number	Altitude — WGS84 reference
`altitudeEGM`	Number	Altitude — EGM96 reference
`heading`	Number	Heading in degrees
`pitch`	Number	Camera pitch angle
`speed`	Number	Speed at this waypoint
`actions`	Array	Actions to perform at this waypoint
`label`	String	Waypoint label
`type`	String	Point type — `point` or `pole`
`isRisky`	Boolean	Whether this waypoint is flagged as risky
`pole`	String	Pole identifier (for infrastructure inspection)
`wo`	String	Work order identifier

Mission Type

Value	Description
`waypoint`	Generic waypoint mission
`mapping2d`	2D survey/mapping mission
`mapping3d`	3D survey/mapping mission
`mappingStrip`	Strip mapping mission
`corridor`	Corridor inspection mission (e.g. powerlines)
`pilot`	Mission imported from DJI Pilot (KML)
`smart-inspect`	Smart inspect mission (oriented to base point)
`drone-harmony`	Mission imported from Drone Harmony (CSV)

Height Mode

Value	Description
`relativeToStartPoint`	Altitude relative to the take-off point
`EGM96`	EGM96 geoid model reference
`WGS84`	WGS84 ellipsoid reference
`realTimeFollowSurface`	Real-time terrain following
`aboveGroundLevel`	Altitude above ground level