Start Flight

"Seamlessly initiate flights with detailed telemetry data retrieval using Aeromegh's startFlight API."

This API enables authorized users to programmatically access detailed information regarding the startFlight process. It facilitates the retrieval of essential parameters such as flight ID, upstream topic, downstream topic, stream key, validity period, stream URI, and stream server base.

Authentication with API Keys

This API uses API keys for authentication. To access the API, you'll need to include a valid API key in the Authorization header of your request using the Bearer token scheme. Here's the format:

Authorization: Bearer <YOUR_API_KEY>
  • Replace <YOUR_API_KEY> with your actual API key obtained from Aeromegh.

  • Requests without a valid API key will result in a 401 Unauthorized error.

Method

POST

HTTP Request

https://ags.aeromegh.com/Aeromegh/startFlight?projectName={projectName}&planName={planName}&droneId={droneId}&teamId={teamId}&firmwareVersion={firmwareVersion}&greenBuildNumber={greenBuildNumber}&areaCalculateMethod={areaCalculateMethod}

URL Parameters

Request Parameters:

ParameterDescription

projectName

Name of the project associated with the flight.

planName

Name of the flight plan to execute.

droneId

Unique identifier for the drone initiating the flight.

teamId

Unique identifier for the team managing the flight.

firmwareVersion

(Optional) Version of the drone's firmware.

greenBuildNumber

(Optional) Build number for the green version.

areaCalculateMethod

(Optional) Specifies the method for area calculation, must be either "spraying" or "plot".

HTTP Response

Response Codes Explanation:

CodeDetailsMessage

200

The request was successful.

"OK"

400

Request parameters missing.

"Request parameters missing"

500

Internal server error.

"Internal server error"

Code Snippet

Take a look at how you might call this method using our official libraries, or via curl:

curl --location --request POST 'https://ags.aeromegh.com/Aeromegh/startFlight?projectName=sandip24april&planName=435pm&droneId=P00001004F002B3131510137383337&teamId=a16afc9b-5205-4fa5-8c42-6276ce1e3281&firmwareVersion=4.4.4&greenBuildNumber=103.265.20240425.01&areaCalculateMethod=spraying' \
--header 'Authorization: Bearer <API_KEY>'

Note: Replace <API_KEY> with the actual API_KEY provided by Aeromegh.

API Response

The API response provides details regarding the initiated flight, including the flight ID, upstream and downstream topics for communication, stream key, validity period, stream URI, and stream server base. Below is an example JSON response illustrating these details:

{
    "flightId": "54e9ce7b-e2b8-455e-b351-590c1bf2abdf",
    "upStreamTopic": "wicqkj7f433mhkzxr8yzf5644vpnv36rtsept99wmq3zwq6h26xqhzaf2k1jlr32",
    "downStreamTopic": "8ft0jnqc14va4tf2hfxmsqt8yg565yzf1hso86cfqp2dgdje1v8rj6o9464syefn",
    "streamKey": "20pr1ospms",
    "validTill": "Sun, 12 May 2024 07:53:48 GMT",
    "streamUri": "rtmp://stream02.aeromegh.com/LiveApp",
    "streamServerBase": "stream02.aeromegh.com"
}

API Response Parameter Details

The API response furnishes details pertinent to the initiated flight. Here's a breakdown of the parameters featured in the response:

ParameterDescription

flightId

Unique identifier for the initiated flight.

upStreamTopic

Topic for upstream communication, facilitating data transmission from the drone to the server.

downStreamTopic

Topic for downstream communication, enabling data reception from the server to the drone.

streamKey

Key used for stream authentication.

validTill

Timestamp indicating the expiration time of the initiated flight.

streamUri

Uniform Resource Identifier (URI) for streaming, specifying the destination for streaming data.

streamServerBase

Base URL of the streaming server facilitating data transmission.

Last updated