API Calling Conventions
SDK Open exposes three public local interfaces: Command WS, Video WS, and Local HTTP. Applications only communicate with the local Runtime; cloud authorization, usage accounting, and provider orchestration are handled internally by the Runtime.
Common Conventions
| Item | Description |
|---|---|
| Data format | Command WS uses JSON requests/responses; Video WS uses text events plus binary frames; Local HTTP handles file upload and task artifact download. |
| Authentication | Call auth.create_session first to create a connection-bound session, then call authorized SDK methods. |
| Response shape | Command WS returns request_id, code, message, data, and ts. |
| Task model | Capture, image enhancement, OCR, file conversion, and SANE scanning may return task_id; poll with the matching *.get method or listen for events. |
| Internationalization | API field names stay stable English identifiers; user-facing text should be localized by the application. |