Streaming
Note: the Start streaming endpoint can only be used to start streaming from a Kaleo Connect device. This endpoint cannot be used to start streaming from a web browser. All other streaming endpoints control both browser and Kaleo Connect devices.
Get streaming status
Read the current session and shared church settings. All fields are present, including while idle.
Path Parameters
churchIdYour church ID. Copy it from the API page (under Integrations) in your dashboard.
Get streaming status › Responses
Success
streamingtrue during an active session, including startup, reconnects, and shutdown. Does not confirm audio is arriving.
sessionIdCurrent session ID; null while idle.
startedAtCurrent session start time; null while idle.
deadlineAtAutomatic stop time; null while idle or if no deadline is recorded.
speakerLanguageCurrent speaker language code; null while idle.
targetLanguagesCurrent translation language codes; empty while idle.
voiceTranslation voice, including while idle.
visibletrue shows captions; false hides them. Also applies while idle.
publisherKaleo Connect device or browser that sends audio; null while idle.
phaseSession stage; idle means no session is active.
Church defaults for the next manual start. Active session overrides do not change these values.
Start streaming
Start streaming on a Kaleo Connect device using saved settings. The optional body can select a deviceId and override settings for this session. Without deviceId, Kaleo picks the default audio source configured on the Kaleo Connect page (under Integrations) in your dashboard if there are multiple audio-capable devices available, or the only available audio source device if just one is available.
Path Parameters
churchIdYour church ID. Copy it from the API page (under Integrations) in your dashboard.
Start streaming › Request Body optional
deviceIdOptional audio source device ID from GET /devices. Overrides the church default for this session. If omitted, use the saved default audio source or the sole audio-source-capable paired device; multiple devices without a default require selection. The selected device must still be ready.
Settings for this session only. Omitted fields use saved defaults.
Start streaming › Responses
Success
streamingtrue during an active session, including startup, reconnects, and shutdown. Does not confirm audio is arriving.
sessionIdCurrent session ID; null while idle.
startedAtCurrent session start time; null while idle.
deadlineAtAutomatic stop time; null while idle or if no deadline is recorded.
speakerLanguageCurrent speaker language code; null while idle.
targetLanguagesCurrent translation language codes; empty while idle.
voiceTranslation voice, including while idle.
visibletrue shows captions; false hides them. Also applies while idle.
publisherKaleo Connect device or browser that sends audio; null while idle.
phaseSession stage; idle means no session is active.
Church defaults for the next manual start. Active session overrides do not change these values.
Stop streaming
Stop the current streaming session. No request body is needed.
Path Parameters
churchIdYour church ID. Copy it from the API page (under Integrations) in your dashboard.
Stop streaming › Responses
Success
streamingtrue during an active session, including startup, reconnects, and shutdown. Does not confirm audio is arriving.
sessionIdCurrent session ID; null while idle.
startedAtCurrent session start time; null while idle.
deadlineAtAutomatic stop time; null while idle or if no deadline is recorded.
speakerLanguageCurrent speaker language code; null while idle.
targetLanguagesCurrent translation language codes; empty while idle.
voiceTranslation voice, including while idle.
visibletrue shows captions; false hides them. Also applies while idle.
publisherKaleo Connect device or browser that sends audio; null while idle.
phaseSession stage; idle means no session is active.
Church defaults for the next manual start. Active session overrides do not change these values.
Change translation voice
Change the translation voice while idle or streaming.
Path Parameters
churchIdYour church ID. Copy it from the API page (under Integrations) in your dashboard.
Change translation voice › Request Body
voiceTranslation voice. Can change while idle or streaming.
Change translation voice › Responses
Success
streamingtrue during an active session, including startup, reconnects, and shutdown. Does not confirm audio is arriving.
sessionIdCurrent session ID; null while idle.
startedAtCurrent session start time; null while idle.
deadlineAtAutomatic stop time; null while idle or if no deadline is recorded.
speakerLanguageCurrent speaker language code; null while idle.
targetLanguagesCurrent translation language codes; empty while idle.
voiceTranslation voice, including while idle.
visibletrue shows captions; false hides them. Also applies while idle.
publisherKaleo Connect device or browser that sends audio; null while idle.
phaseSession stage; idle means no session is active.
Church defaults for the next manual start. Active session overrides do not change these values.
Change visibility
Show or hide captions while idle or streaming. Hiding captions does not stop the session.
Path Parameters
churchIdYour church ID. Copy it from the API page (under Integrations) in your dashboard.
Change visibility › Request Body
visibletrue shows captions; false hides them while streaming continues.
Change visibility › Responses
Success
streamingtrue during an active session, including startup, reconnects, and shutdown. Does not confirm audio is arriving.
sessionIdCurrent session ID; null while idle.
startedAtCurrent session start time; null while idle.
deadlineAtAutomatic stop time; null while idle or if no deadline is recorded.
speakerLanguageCurrent speaker language code; null while idle.
targetLanguagesCurrent translation language codes; empty while idle.
voiceTranslation voice, including while idle.
visibletrue shows captions; false hides them. Also applies while idle.
publisherKaleo Connect device or browser that sends audio; null while idle.
phaseSession stage; idle means no session is active.
Church defaults for the next manual start. Active session overrides do not change these values.
Clear captions
Clear the current caption feed. No request body is needed.
Path Parameters
churchIdYour church ID. Copy it from the API page (under Integrations) in your dashboard.
Clear captions › Responses
Success
streamingtrue during an active session, including startup, reconnects, and shutdown. Does not confirm audio is arriving.
sessionIdCurrent session ID; null while idle.
startedAtCurrent session start time; null while idle.
deadlineAtAutomatic stop time; null while idle or if no deadline is recorded.
speakerLanguageCurrent speaker language code; null while idle.
targetLanguagesCurrent translation language codes; empty while idle.
voiceTranslation voice, including while idle.
visibletrue shows captions; false hides them. Also applies while idle.
publisherKaleo Connect device or browser that sends audio; null while idle.
phaseSession stage; idle means no session is active.
Church defaults for the next manual start. Active session overrides do not change these values.
Change auto-stop deadline
Set the auto-stop time for an active session. Returns the updated streaming status.
Path Parameters
churchIdYour church ID. Copy it from the API page (under Integrations) in your dashboard.
Change auto-stop deadline › Request Body
deadlineAtFuture auto-stop time with Z or a timezone offset. No later than six hours after startedAt.
Change auto-stop deadline › Responses
Success
streamingtrue during an active session, including startup, reconnects, and shutdown. Does not confirm audio is arriving.
sessionIdCurrent session ID; null while idle.
startedAtCurrent session start time; null while idle.
deadlineAtAutomatic stop time; null while idle or if no deadline is recorded.
speakerLanguageCurrent speaker language code; null while idle.
targetLanguagesCurrent translation language codes; empty while idle.
voiceTranslation voice, including while idle.
visibletrue shows captions; false hides them. Also applies while idle.
publisherKaleo Connect device or browser that sends audio; null while idle.
phaseSession stage; idle means no session is active.
Church defaults for the next manual start. Active session overrides do not change these values.
Adjust auto-stop time
Add or subtract auto-stop time. While idle, change the duration for the next manual start. While streaming, change the current deadline. Each request applies a separate adjustment.
Path Parameters
churchIdYour church ID. Copy it from the API page (under Integrations) in your dashboard.
Adjust auto-stop time › Request Body
deltaSecondsSeconds to add to the idle duration or current deadline; negative values subtract. Cannot be 0. Idle duration: 60–21600 seconds. Live deadline: future, within six hours of startedAt.
Adjust auto-stop time › Responses
Success
streamingtrue during an active session, including startup, reconnects, and shutdown. Does not confirm audio is arriving.
sessionIdCurrent session ID; null while idle.
startedAtCurrent session start time; null while idle.
deadlineAtAutomatic stop time; null while idle or if no deadline is recorded.
speakerLanguageCurrent speaker language code; null while idle.
targetLanguagesCurrent translation language codes; empty while idle.
voiceTranslation voice, including while idle.
visibletrue shows captions; false hides them. Also applies while idle.
publisherKaleo Connect device or browser that sends audio; null while idle.
phaseSession stage; idle means no session is active.
Church defaults for the next manual start. Active session overrides do not change these values.

