TypeScript SDK Reference / RemoteHealthAnalyzerConfig

Interface: RemoteHealthAnalyzerConfig

Extended by

• VitalSignEngineConfig

Properties

apiKey?

optional apiKey: string

API key for authenticating requests to the backend.

---

dataWindowDuration?

optional dataWindowDuration: number

Duration in seconds of face data to collect in a sliding window. Default is 15.

---

debugMode?

optional debugMode: boolean

When true, automatically persist request/response payloads to the internal dev S3 bucket (panopticai-internal-log-bucket).

---

enabledROIs?

optional enabledROIs: PixelROI[]

List of enabled regions of interest (ROIs) for data extraction.

---

enableSavingRequest?

optional enableSavingRequest: boolean

Whether to enable saving of requests for debugging purposes.

---

endpointURL?

optional endpointURL: string

Full override for the V2 get-health endpoint URL, including path (for example http://localhost:3000/get-health).

---

httpCall()?

optional httpCall: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Custom HTTP function to use instead of the built-in fetch.

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

URL | RequestInfo

init?

RequestInit

Returns

Promise<Response>

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

URL | RequestInfo

init?

RequestInit

Returns

Promise<Response>

---

landmarksSampleRate?

optional landmarksSampleRate: number

Sample rate in FPS for facial landmarks sent to backend. Default is 10.

---

serverId?

optional serverId: ServerId

The ID of the backend server to use for analysis.

---

serverUrl?

optional serverUrl: string

Custom URL of the backend server. If not provided, uses default URL for serverId.