Invisible SFX API (prototype)

This page documents the current prototype endpoints used internally by the lab UI. Public keys, authentication and rate‑limits are not finalized; treat all examples below as preview‑only.

Base URL

https://invisiblesfx.uk/api/

Health check

Simple endpoint used by the web client to keep connections warm and probe latency.

GET /ping

Generate single SFX pattern

Requests a short pattern descriptor that can be used to drive a local sampler or synth engine. The browser UI calls this endpoint periodically while you keep the lab page open.

GET /api/sfx?mode=single
Accept: application/json
    

Example response:

{
  "id": "shadow-sweep-02",
  "duration_ms": 2300,
  "layers": 3,
  "band": "mid-high",
  "intensity": 0.42
}
    

Live stream hints

For longer streams a client can periodically request small control frames that describe how the background layer should evolve over time.

GET /api/stream/hints?session=SESSION_ID
Accept: application/json
    

Client integration notes

• All endpoints are designed to be polled over HTTPS with small payloads.
• Clients are expected to cache patterns locally and reuse them to avoid unnecessary traffic.
• The lab UI may run additional background probes to observe network behaviour. This traffic is limited and anonymous.

Full public API access is not enabled on this instance. The current deployment is intended for internal experiments only.