FlightHub Sync
  1. Task distribution
FlightHub Sync
  • FlightHub
    • FlightFub Webhook
    • ENV
    • Error Code
    • Live stream forwarding
      • Start Stream Forwarding
      • Stop Stream Forwarding
      • Get Stream Forwarding Channel Transcoder
    • Task distribution
      • Get Flight Task Files List
        GET
      • Create Flight Task
        POST
      • Commands During the Flight Task
        POST
      • Flight Task Trajectory Acquisition
        GET
      • Project Equipment Topology
        GET
      • Get Flight Task Details
        GET
    • Get Organization Project List
      GET
    • Get Project Device List
      GET
    • Push Event Notification and Map Annotation
      POST
    • Get Temporary Upload Token
      POST
    • Notify of Route File Upload
      POST
    • Get File Information and Download Address
      GET
  1. Task distribution

Create Flight Task

POST
/task/api/v1.0/projects/{project_uuid}/flight-tasks

Request

Path Params
project_uuid
string 
required
Header Params
X-Organization-Key
string 
required
Organization-Key
Example:
{{organization_key}}
Body Params application/json
name
string 
required
Flight task name
sn
string 
required
Departure dock SN
landing_dock_sn
string 
optional
Landing dock SN, not required for non-frog jump task
time_zone
string 
required
Time zone, the time zone name in the TZ database
wayline_uuid
string 
required
Flight task file uuid
rth_altitude
number 
required
Return altitude, in meters, currently only integers are accepted
rth_mode
enum<integer> 
optional
Return home mode (0: Intelligent Altitude 1: Set Altitude)
Allowed values:
01
Default:
1
wayline_precision_type
enum<integer> 
optional
Task accuracy (0: GPS 1: RTK)
Allowed values:
01
Default:
1
out_of_control_action_in_flight
enum<integer> 
required
Drone action after signal loss (1: return 2: continue execution)
Allowed values:
12
resumable_status
enum<string> 
required
Automatic resume flight task(auto: automatic resume flight task. manual: manual resume flight task)
Allowed values:
automanual
tags
array[string]
optional
Device direct transmission tag
>= 0 items<= 10 items
media_direct_transfer
boolean 
optional
Device direct transmission switch, if it is empty, upload to FlightHub 2.
Default:
false
task_type
enum<integer> 
required
Currently only supports immediate tasks (type 1)
Allowed value:
1
Example
{
  "name": "Flight Task 1",
  "sn": "DOCKSN1",
  "landing_dock_sn": "DOCKSN2",
  "time_zone": "Asia/Chongqing",
  "wayline_uuid": "3f6fa0d6-765d-4b7d-92c5-1a2213b8c0f0",
  "rth_altitude": 24,
  "out_of_control_action_in_flight": 2,
  "resumable_status": "auto",
  "task_type": 1
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/task/api/v1.0/projects//flight-tasks' \
--header 'X-Organization-Key: {{organization_key}}' \
--header 'X-Organization-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Flight Task 1",
    "sn": "DOCKSN1",
    "landing_dock_sn": "DOCKSN2",
    "time_zone": "Asia/Chongqing",
    "wayline_uuid": "3f6fa0d6-765d-4b7d-92c5-1a2213b8c0f0",
    "rth_altitude": 24,
    "out_of_control_action_in_flight": 2,
    "resumable_status": "auto",
    "task_type": 1
}'

Responses

🟢200OK
application/json
Body
body
object 
required
code
integer 
required
data
object 
required
message
string 
required
headers
object 
required
size
integer 
required
status
integer 
required
Example
{
  "body": {
    "code": 0,
    "data": {
      "task": {
        "begin_at": 1718705485,
        "uuid": "1280bab3-3b0d-4517-a53c-3257e48319e5",
        "wayline_validity_check_codes": null
      }
    },
    "message": "success"
  },
  "headers": {},
  "size": 152,
  "status": 200
}
🟢200OK
Modified at 2024-11-08 03:18:42
Previous
Get Flight Task Files List
Next
Commands During the Flight Task
Built with