1. Organization & Project
FlightHub 2 OpenAPI V2.0 (Public Cloud)
  • FlightHub 2 OpenAPI V2.0
    • Usage Guide
      • Authentication Tutorial
      • Error Code
    • Common
      • Common Tutorial
      • System Health & Access
        • Query FlightHub 2 System Status
        • Query System Health Status
        • Get Project Storage Upload STS Credentials
      • Security
        • SN Decrypt Echo
    • Organization & Project
      • Organization & Project Tutorial
      • Members & Permissions Management
        • Project Members
          • Add Members to Project
          • Get Project User List
          • Get Project Independent Member List
        • Organization Members
          • Get Organization User List
          • Get Current User's Organization Role
        • Roles & Permissions
          • Get Role List
          • Get Permission List
          • Get Role Permissions
      • Project Management
        • Project Collaboration
          • Get Project Quick-Join Information
        • Project Configuration
          • Get Auto Recording Config
        • Project Basic Info
          • Get Project List Under Organization
      • Organization Management
        • Organization Basic Info
          • Get Organization List
          • Get Organization Details
    • Device Management
      • Device Management Tutorial
      • Device List Management
        • Device List (Organization Scope)
          • Get Device List Under Organization
        • Device List (Project Scope)
          • Get Project Device Details
          • Get Project Device List
          • Update Device's Bound Project
          • Get Project Device History Topology
      • Device Configuration
        • Calibration & Positioning
          • Custom Network RTK Calibration
        • Pairing Management
          • Query Relay Pairing Result
          • Make Device Enter Relay Pairing Mode
      • Get HMS Information
      • Acquire Control Permission
      • Release Control Permission
      • Live View Quality Settings
      • Get Thing Model
    • Real-time Control
      • Real-time Control Tutorial
      • Control Permission Management
        • Device Control Permission
          • Query Device Control Status (Organization Device )
          • Query Device Control Status (Project Device)
        • Cloud Control Permission
          • Get Cloud Control Status
      • Payload Control
        • Camera Control
          • Aircraft Lens Switch
          • Dock Camera Switch
      • Flight Control Commands
        • General Real-time Commands
          • Query Device Command Execution
          • Send Real-time Control Command
      • Takeoff/Landing Coordination
        • Query Takeoff/Landing Coordination Area (TCA) Real-time Status
    • Livestream
      • Livestream Tutorial
      • Query Recording Tasks
        • Get Recording Tasks for Project Device
        • Get Recording Tasks for Organization Device
      • Livestream Sharing & Forwarding
        • Bypass Streaming
          • Create Stream Converter
          • Get Stream Converter List
          • Delete Stream Converter
          • Enable/Disable Stream Converter
        • Livestream Sharing
          • Get Device Livestream Share Details
          • Get Device Livestream Share List
      • Livestream Push
        • Start Livestream
    • Flight Task
      • Flight Task Tutorial
      • AI Flight Alerts
        • Query Flight Task Alert Records
        • Query AI Alert Records
      • Task Creation
        • Check Whether Flight Task Meets Dispatch Conditions
        • Create Flight Task
        • Resumable Immediate Task
      • Task Query
        • Get Recent Flight Task List
        • Get Default Task Name on Creation
        • Get Flight Task List
        • Get Flight Task Track Information
        • Get Wayline Task Details
        • Get Flight Task Information
        • Get Flight Task List
        • Get Media Resources from Flight Task
      • Flight Record
        • Get Export History
        • Get Single Flight Record Download Link
        • Get Wayline Task Operation Log
      • Task Update
        • Update Flight Task Status
    • Wayline
      • Wayline Tutorial
      • Wayline Management
        • Wayline Query
          • Get Wayline Details
          • Get Wayline List Under Project
        • Wayline Upload
          • Wayline Upload Completion Notification
    • Map
      • Map Tutorial
      • Map Annotation
        • Annotation Creation
          • Create Map Annotation
        • Annotation Update
          • Annotation Update
        • Annotation Deletion
          • Annotation Deletion
      • Airspace Safety
        • Terrain Obstacles
          • Get Offline Map URL
          • Get Offline Map Details
        • Custom Flight Area
          • Get Flight Area List (Workspace Scope)
          • Get Flight Area File URL
          • Get Flight Area List (Project Scope)
      • Airspace Warning
        • Airspace Warning
    • Model Reconstruction
      • Model Reconstruction Tutorial
      • Get Project Model List
      • Model Reconstruction
      • Get Model Details
      • Get Model File Download Link
    • Open Modeling
      • Open Modeling Tutorial
      • Start Reconstruction Task
      • Get Model Details
      • Delete Model
      • Stop Reconstruction Task
      • Get Resource Details
      • Delete Resource
      • Get Upload Credentials
      • Upload Callback
      • Get In-Progress Reconstruction Model Details
  1. Organization & Project

Organization & Project Tutorial

Overview#

The Organization & Project module covers full information queries across two foundational dimensions in FlightHub 2 - organization and project. Compared to the original "Organization Project" module, it is more comprehensive and includes:
Members & Permissions Management: Query interfaces for project members, organization members, roles, and permissions, used for rendering member lists, loading current user role context, and rendering role/permission assignment panels.
Project Management: Project collaboration (scan-to-join), project configuration (auto-recording), and project basic information (project list under organization).
Organization Management: List of organizations the current user has joined, and details of a single organization.
This module currently focuses on query capabilities. Creation and binding of organizations / projects / roles must still be done in the FlightHub 2 console.
For how to obtain request headers such as X-Project-Uuid and X-User-Token, refer to the Authentication Tutorial under Root Directory.

Interface Usage Flow#

Organization / Project basic info loading:
Member and role info loading:
Role and permission query:
Project collaboration and configuration:
Call steps:
1.
Load organization / project basic info: First use Get Organization List (GET /openapi/v2.0/organizations) to obtain the current user's organization list, then use Get Organization Details (GET /openapi/v2.0/organizations/{uuid}) and Get Project List Under Organization (GET /openapi/v2.0/project) to load organization details and the project list under the organization. The project uuid can be filled into the X-Project-Uuid header of subsequent requests.
2.
Render members and roles: Use Get Current User's Organization Role (GET /openapi/v2.0/organizations/{uuid}/users/current) to retrieve the full context of the current user within the organization. Use Get Organization User List (GET /openapi/v2.0/organizations/{uuid}/users), Get Project User List (GET /openapi/v2.0/users), and Get Project Independent Member List (GET /openapi/v2.0/members) to populate member lists by organization / project / project-independent member dimensions respectively.
3.
Render the role and permission management panel: Call Get Role List (GET /openapi/v2.0/organizations/{uuid}/roles), Get Permission List (GET /openapi/v2.0/organizations/{uuid}/permissions), and Get Role Permissions (GET /openapi/v2.0/organizations/{uuid}/roles/permissions) to obtain roles, the permission tree, and permissions bound to the role.
4.
Collaboration and configuration loading: Call Get Project Quick-Join Information (GET /openapi/v2.0/projects/join-codes) for pre-validation before scanning to join a project. On the project settings page, use Get Auto Recording Config (GET /openapi/v2.0/auto-record-configs) to load the initial values of the auto-recording configuration.

Project Members and Device Binding#

Overview#

The Organization & Project module supports retrieving the FlightHub 2 project list, device list, and the project's storage upload credentials.
Note: Creating organizations, creating projects, and binding devices via API is not currently supported. Please refer to the FlightHub 2 User Manual: Organization Management chapter to perform related creation and binding operations in FlightHub 2.
The project's storage upload credentials can be used for wayline file uploads. For detailed usage flow, refer to the Wayline Management Tutorial.

Interface Usage Flow#

The following uses the device lens switching feature as an example to illustrate the related interface call flow. For other more detailed features, please refer to the specific interface descriptions.

Project Device Details#

Project Device Tutorial#

Overview#

The Project Device module is used to query details of a specified device under the current project, including device model, SN, and the device's aliases within the project and organization.
This module only provides the ability to query a single device's details by SN. To list all devices under the project, please use the Get Project Device List (GET /openapi/v2.0/project/device) interface in the "Organization Project" module.

Interface Usage Flow#

The typical usage is to first obtain the target SN from Get Project Device List (GET /openapi/v2.0/project/device), then call this interface to get the details.
Call steps:
1.
Use Get Project Device List (GET /openapi/v2.0/project/device) to obtain the SN list of devices in the project.
2.
Call Get Project Device Details (GET /openapi/v2.0/project/device/{sn}), passing the sn path parameter and the X-User-Token / X-Project-Uuid request headers, to obtain the details of this device under the current project.

Project Device History Topology#

Project Team Tutorial#

Overview#

The Project Team module is used to query a project's historical device topology, helpful for reviewing the combinations of docks / remote controllers / aircraft that have been connected to the project.
This interface is for historical display only; the returned nodes' online status is always false. To view a device's current online status, please use the device list interface in the "Device Management" module.

Interface Usage Flow#

Call steps:
1.
Use Get Project List Under Organization (GET /openapi/v2.0/project) to obtain the target project's uuid.
2.
Call Get Project Device History Topology (GET /openapi/v2.0/topologies/history), with X-User-Token and X-Project-Uuid in the request headers, to obtain the historical device topology under this project for team/device combination retrospection display.
Modified at 2026-05-26 14:32:16
Previous
SN Decrypt Echo
Next
Add Members to Project
Built with