본문으로 건너뛰기
Version: 1.0.0

Neat Insight API

Neat Insight provides an HTTP control plane for preparing media, managing indexed streaming sources, discovering vf viewer URLs, inspecting runtime health, and browsing the active workspace. The same API drives the Insight web application and can be used from scripts, test automation, or development tools.

Before you begin​

  • The default local endpoint is https://127.0.0.1:9900. Development installations normally use a locally generated certificate, so diagnostic clients may need to trust mkcert or use curl -k.
  • Call GET /api/health before a workflow to confirm that the backend is ready.
  • Media and workspace paths are always relative to their managed root. Absolute paths and traversal outside those roots are rejected.
  • Source slot indexes are one-based; vf viewer channel indexes are zero-based.
  • Operations that import, transcode, or upload media may return a streaming text/plain progress response. Read through the final line before deciding whether the operation succeeded.

Typical workflows​

  1. Prepare a stream: upload or import media, inspect it, assign it to a source slot, then start the source.
  2. Open a viewer: request /api/viewer-url so the URL reflects the current host and configured SDK channel capacity.
  3. Troubleshoot delivery: check ingest statistics first; if RTP reaches vf but the browser still fails, continue with egress statistics.
  4. Inspect artifacts: browse the workspace tree, search paths, and preview files or members inside MPK archives.

Security​

The API has no application-level authentication. Expose it only on trusted development networks and place an authenticated gateway in front of it if broader access is required.