FlightHub Sync API manages the APIs for interaction between FlightHub and third-party cloud platforms.

Note: FlightHub Sync API will be gradually migrated to FlightHub Sync OpenAPI. New users should use FlightHub Sync and EventAPI directly.

When using the FlightHub Sync API, please note the following:

• Users must include the X-Organization-Key header in requests. This key serves as the organization’s authentication credential.
• Users can call the Get the List of Projects Under the Organization, Get the List of Devices for a Specific Project, and Get Task Details APIs to obtain related information about tasks and devices.
• The Organization ID can be obtained from the URL when users access the FlightHub 2 Project List page.

Public Cloud

On-Premises Version

FlightHub Sync Webhook

When a file is generated, FlightHub 2 sends a notification to the third-party cloud platform via the configured Webhook URL.

Note: FlightHub Sync has introduced a new EventAPI service that supports a wider range of event types and more flexible rule configurations. For details, see EventAPI.

New File Generated Notification API:

{
    "notify_type": "file_uploaded",
    "notify_time": "2023-11-07T12:00:00.582627+00:00",
    "data": {
        "organization_id": "Organization ID",
        "workspace_id": "Project ID",
        "file": {
            "id": "File ID",
            "name": "File Name",
            "object_key": "Object Storage Key",
            "type": 5 // 5-Flight route files，7-3D mapping files
        }
    }
}

FlightHub Sync API

The following APIs will be gradually migrated to FlightHub Sync OpenAPI:

Interface Pins	Migration Status
Get AI Warning List & Snapshot	Migrated to EventAPI
Get the list of projects under the organization	Migrating
Get the list of devices for a specific project	Migrating
Publish notifications and create map elements	Migrating
Get temporary upload credentials for a project	Migrating
Flight route upload notification	Migrating
Get the generated file info and download URL	Migrating
Bypass streaming API	Migrating
Task distribution API	Migrating

For details on other requests, see the FlightHub Sync API Overview.

Note: FlightHub Sync has completed public beta testing and has been upgraded to FlightHub Sync. The stream forwarding feature deducts livestream minutes from the current organization. Deduction starts when a transcoder is created (stream forwarding initiated). Each transcoder counts independently. Deleting the transcoder (stopping stream forwarding) ends consumption.