v13

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-01151218.0 KB
Stream Manager

Launch an lk load-test run

Starts a single lk load-test process that simulates many publishers/subscribers in one room. Used by the controller when a test case's browser is set to emulated. Simulcast is enabled by default. Unlike the streamManager path, this does not publish custom/reference media (lk load-test uses its own synthetic clip).

post/openvidu-browser/load-test

Request body

openviduUrlstring required
livekitApiKeystring required
livekitApiSecretstring required
roomstring required
videoPublishersinteger

Number of participants publishing video tracks. Each one also publishes an audio track and subscribes to other participants' tracks (mirroring a NORMAL-mode publisher), adding to audioPublishers/subscribers below rather than replacing them.

audioPublishersinteger

Number of participants publishing only an audio track, in addition to the audio publishers implied by videoPublishers

subscribersinteger

Number of participants that only subscribe, in addition to the subscribers implied by videoPublishers

numPerSecondinteger

Number of testers to start every second (ramp)

videoResolution'low' | 'medium' | 'high'
videoCodec'h264' | 'vp8'
simulcastboolean

Simulcast is disabled by default; set true to opt in

layout'speaker' | '3x3' | '4x4' | '5x5'

Defaults to "5x5" when omitted (lk load-test itself defaults to "speaker")

participantIdsstring[]

Synthetic participant ids (e.g. "User1", "User2") assigned to this chunk's publishers/subscribers, in order. When Elasticsearch monitoring is enabled, one webrtc-stats document per id is indexed with node_role: browseremulator, matching NORMAL mode's per-participant reporting.

Response

Load-test run started successfully

runIdstring
handleIdstring
roomstring
workerCpuUsagenumber