1. Bypass Streaming
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
            POST
          • Get Stream Converter List
            GET
          • Delete Stream Converter
            DELETE
          • Enable/Disable Stream Converter
            PUT
        • 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. Bypass Streaming

Create Stream Converter

POST
/openapi/v2.0/live-stream/converter
Create a stream converter. Calling this interface creates and stores a stream converter on FlightHub 2. You can call Get Stream Converter List to obtain created converters, then call Enable/Disable Stream Converter to turn on stream forwarding.
Up to 20 stream converters can be created.

Request

Header Params

Body Params application/json

Example
{
    "converter_name": "my_converter",
    "sn": "4SEDL9F0011RY2",
    "camera_index": "165-0-7",
    "schema": "rtmp",
    "schema_option": {
        "url": "rtmp://live.restream.io/live/re_7734128_5da13a862901ce2d4084"
    }
}

Request Code 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 '/openapi/v2.0/live-stream/converter' \
--header 'X-User-Token: {{X-User-Token}}' \
--header 'X-Project-Uuid: e7b81eec-f182-473a-9368-9e220e46f9d9' \
--header 'X-Request-Id: {{$string.uuid}}' \
--header 'X-Request-Id: {{$string.uuid}}' \
--header 'X-Language: zh' \
--header 'X-Language: zh' \
--header 'Content-Type: application/json' \
--data '{
    "converter_name": "my_converter",
    "sn": "4SEDL9F0011RY2",
    "camera_index": "165-0-7",
    "schema": "rtmp",
    "schema_option": {
        "url": "rtmp://live.restream.io/live/re_7734128_5da13a862901ce2d4084"
    }
}'

Responses

🟢200
application/json
Bodyapplication/json

Example
{
    "code": 0,
    "message": "",
    "data": {
        "converter_id": "aadb854a-cf8d-4436-99dd-a57692c0dd99"
    }
}
🟠400
🟠401
🟠403
🔴500
Modified at 2026-09-02 07:50:15
Previous
Get Recording Tasks for Organization Device
Next
Get Stream Converter List
Built with