Skip to content

Enterprise Open API

Overview

Enterprise Open APIs let third-party languages call the control center over HTTP (Python, C++, Easy Language, etc.), even without EC JavaScript.

  • Method: HTTP (mostly POST, Content-Type: application/json)
  • URL prefix: control center base, e.g. http://127.0.0.1:8019, plus the endpoint path
  • Response: code 0 = success; otherwise failure, see msg
  • Docs are split by module (from Apifox export + USB HID chapter). Use the table below.

Request examples

Replace BASE with your control-center URL. The samples list devices, then run USB HID: start session → set screen size → click.

Get deviceId from the device list response.

import requests
BASE = "http://127.0.0.1:8019"
def openapi_post(path, body=None):
r = requests.post(f"{BASE}{path}", json=body or {}, timeout=30)
r.raise_for_status()
data = r.json()
if data.get("code") != 0:
raise RuntimeError(data.get("msg") or data)
return data
# 1) Device list
print(openapi_post("/openapi/deviceList", {"deviceId": "", "groupId": ""}))
# 2) USB HID: session → screen size → click
DEVICE_ID = "90e2f3834c0977205e441aa664916a9bdde81e8d"
openapi_post("/openapi/usbhidSessionStart", {"deviceId": DEVICE_ID, "gate": True})
openapi_post("/openapi/usbhidSetScreenSize", {"deviceId": DEVICE_ID, "w": 1170, "h": 2532})
openapi_post("/openapi/usbhidClickPoint", {"deviceId": DEVICE_ID, "x": 200, "y": 400})

Dependency: pip install requests

Other endpoints follow the same POST + JSON body pattern — swap the path and body using each module page.

Modules

ModuleDescription
Automation · ScreenshotCapture / stream
Automation · ActionsTap, swipe, input, apps
Automation · EnvStart/stop automation, tunnel
Automation · AlbumUpload / clear album
Automation · FilesPush / pull device files
Automation · IMECustom keyboard / clipboard
Automation · BLEBluetooth HID board
Automation · USB HIDNo extra board, USB cable control
Center APIsDevice list, scripts
App helperClipboard, album, port forward
Shortcuts helperRequires Shortcuts helper app; see page for paths

Notes

  • USB HID: no BLE/OTG board; see the USB HID chapter for endpoints
  • Screen presets: new UI guide

Legacy Apifox (backup)

Online link (incomplete USB HID — prefer on-site docs):