Streaming

Baixar esquema

Nota: o endpoint Iniciar streaming só pode ser usado para iniciar streaming a partir de um dispositivo Kaleo Connect. Este endpoint não pode ser usado para iniciar streaming a partir de um navegador web. Todos os outros endpoints de streaming controlam tanto navegadores quanto dispositivos Kaleo Connect.

Obter status de streaming

GET

https://babel.withkaleo.com

/v1/church/{churchId}/streaming

Bearer (API key)

Leia a sessão atual e as configurações compartilhadas da igreja. Todos os campos estão presentes, inclusive quando ocioso.

Obter status de streaming › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

Obter status de streaming › Respostas

Sucesso

Sessão atual e configurações compartilhadas da igreja. Todos os campos estão presentes, inclusive quando ocioso.

StreamingStatus

streaming

boolean · obrigatório

true durante uma sessão ativa, incluindo inicialização, reconexões e desligamento. Não confirma que o áudio está chegando.

sessionId

string | null · obrigatório

ID da sessão atual; null enquanto ocioso.

startedAt

string | null · date-time · obrigatório

Hora de início da sessão atual; null enquanto ocioso.

deadlineAt

string | null · date-time · obrigatório

Hora de parada automática; null enquanto ocioso ou se nenhum prazo está registrado.

speakerLanguage

string | null · obrigatório

Código do idioma do locutor atual; null enquanto ocioso.

targetLanguages

string[] · obrigatório

Códigos dos idiomas de tradução atuais; vazio enquanto ocioso.

voice

string · enum · obrigatório

Voz da tradução, inclusive enquanto ocioso.

Valores do enumeração:

male

female

visible

boolean · obrigatório

true mostra legendas; false as oculta. Também se aplica enquanto ocioso.

publisher

object | null · obrigatório

Dispositivo Kaleo Connect ou navegador que envia áudio; null enquanto ocioso.

phase

string · enum · obrigatório

Estágio da sessão; ocioso significa que nenhuma sessão está ativa.

Valores do enumeração:

idle

starting

streaming

reconnecting

ending

object · obrigatório

Padrões da igreja para o próximo início manual. Substituições da sessão ativa não alteram esses valores.

Iniciar streaming

POST

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/start

Bearer (API key)

Inicie o streaming em um dispositivo Kaleo Connect usando configurações salvas. O corpo opcional pode selecionar um deviceId e substituir configurações para esta sessão. Sem deviceId, Kaleo escolhe a fonte de áudio padrão configurada na página Kaleo Connect (em Integrações) no seu painel se houver vários dispositivos com capacidade de áudio disponíveis, ou o único dispositivo fonte de áudio disponível se houver apenas um.

Iniciar streaming › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

Iniciar streaming › Corpo da requisição opcional

StartStreaming

deviceId

string

ID opcional do dispositivo fonte de áudio de GET /devices. Substitui o padrão da igreja para esta sessão. Se omitido, use a fonte de áudio padrão salva ou o único dispositivo pareado com capacidade de áudio; múltiplos dispositivos sem padrão requerem seleção. O dispositivo selecionado deve estar pronto.

object

Configurações apenas para esta sessão. Campos omitidos usam padrões salvos.

Iniciar streaming › Respostas

Sucesso

Sessão atual e configurações compartilhadas da igreja. Todos os campos estão presentes, inclusive quando ocioso.

StreamingStatus

streaming

boolean · obrigatório

true durante uma sessão ativa, incluindo inicialização, reconexões e desligamento. Não confirma que o áudio está chegando.

sessionId

string | null · obrigatório

ID da sessão atual; null enquanto ocioso.

startedAt

string | null · date-time · obrigatório

Hora de início da sessão atual; null enquanto ocioso.

deadlineAt

string | null · date-time · obrigatório

Hora de parada automática; null enquanto ocioso ou se nenhum prazo está registrado.

speakerLanguage

string | null · obrigatório

Código do idioma do locutor atual; null enquanto ocioso.

targetLanguages

string[] · obrigatório

Códigos dos idiomas de tradução atuais; vazio enquanto ocioso.

voice

string · enum · obrigatório

Voz da tradução, inclusive enquanto ocioso.

Valores do enumeração:

male

female

visible

boolean · obrigatório

true mostra legendas; false as oculta. Também se aplica enquanto ocioso.

publisher

object | null · obrigatório

Dispositivo Kaleo Connect ou navegador que envia áudio; null enquanto ocioso.

phase

string · enum · obrigatório

Estágio da sessão; ocioso significa que nenhuma sessão está ativa.

Valores do enumeração:

idle

starting

streaming

reconnecting

ending

object · obrigatório

Padrões da igreja para o próximo início manual. Substituições da sessão ativa não alteram esses valores.

POST/v1/church/{churchId}/streaming/start

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/start \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Exemplo de corpo da requisição

{}

json

application/json

Exemplos de respostas

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "male",
  "visible": true,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Parar streaming

POST

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/stop

Bearer (API key)

Pare a sessão de streaming atual. Nenhum corpo de solicitação é necessário.

Parar streaming › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

Parar streaming › Respostas

Sucesso

Sessão atual e configurações compartilhadas da igreja. Todos os campos estão presentes, inclusive quando ocioso.

StreamingStatus

streaming

boolean · obrigatório

true durante uma sessão ativa, incluindo inicialização, reconexões e desligamento. Não confirma que o áudio está chegando.

sessionId

string | null · obrigatório

ID da sessão atual; null enquanto ocioso.

startedAt

string | null · date-time · obrigatório

Hora de início da sessão atual; null enquanto ocioso.

deadlineAt

string | null · date-time · obrigatório

Hora de parada automática; null enquanto ocioso ou se nenhum prazo está registrado.

speakerLanguage

string | null · obrigatório

Código do idioma do locutor atual; null enquanto ocioso.

targetLanguages

string[] · obrigatório

Códigos dos idiomas de tradução atuais; vazio enquanto ocioso.

voice

string · enum · obrigatório

Voz da tradução, inclusive enquanto ocioso.

Valores do enumeração:

male

female

visible

boolean · obrigatório

true mostra legendas; false as oculta. Também se aplica enquanto ocioso.

publisher

object | null · obrigatório

Dispositivo Kaleo Connect ou navegador que envia áudio; null enquanto ocioso.

phase

string · enum · obrigatório

Estágio da sessão; ocioso significa que nenhuma sessão está ativa.

Valores do enumeração:

idle

starting

streaming

reconnecting

ending

object · obrigatório

Padrões da igreja para o próximo início manual. Substituições da sessão ativa não alteram esses valores.

Alterar voz da tradução

PATCH

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/voice

Bearer (API key)

Altere a voz da tradução enquanto estiver ocioso ou transmitindo.

Alterar voz da tradução › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

Alterar voz da tradução › Corpo da requisição

ChangeVoice

voice

string · enum · obrigatório

Voz da tradução. Pode ser alterada enquanto ocioso ou transmitindo.

Valores do enumeração:

male

female

Alterar voz da tradução › Respostas

Sucesso

Sessão atual e configurações compartilhadas da igreja. Todos os campos estão presentes, inclusive quando ocioso.

StreamingStatus

streaming

boolean · obrigatório

true durante uma sessão ativa, incluindo inicialização, reconexões e desligamento. Não confirma que o áudio está chegando.

sessionId

string | null · obrigatório

ID da sessão atual; null enquanto ocioso.

startedAt

string | null · date-time · obrigatório

Hora de início da sessão atual; null enquanto ocioso.

deadlineAt

string | null · date-time · obrigatório

Hora de parada automática; null enquanto ocioso ou se nenhum prazo está registrado.

speakerLanguage

string | null · obrigatório

Código do idioma do locutor atual; null enquanto ocioso.

targetLanguages

string[] · obrigatório

Códigos dos idiomas de tradução atuais; vazio enquanto ocioso.

voice

string · enum · obrigatório

Voz da tradução, inclusive enquanto ocioso.

Valores do enumeração:

male

female

visible

boolean · obrigatório

true mostra legendas; false as oculta. Também se aplica enquanto ocioso.

publisher

object | null · obrigatório

Dispositivo Kaleo Connect ou navegador que envia áudio; null enquanto ocioso.

phase

string · enum · obrigatório

Estágio da sessão; ocioso significa que nenhuma sessão está ativa.

Valores do enumeração:

idle

starting

streaming

reconnecting

ending

object · obrigatório

Padrões da igreja para o próximo início manual. Substituições da sessão ativa não alteram esses valores.

PATCH/v1/church/{churchId}/streaming/voice

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/voice \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "voice": "female"
}'

Exemplo de corpo da requisição

{
  "voice": "female"
}

json

application/json

Exemplos de respostas

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "female",
  "visible": true,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Alterar visibilidade

PATCH

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/visibility

Bearer (API key)

Mostrar ou ocultar legendas enquanto estiver ocioso ou transmitindo. Ocultar legendas não interrompe a sessão.

Alterar visibilidade › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

Alterar visibilidade › Corpo da requisição

ChangeVisibility

visible

boolean · obrigatório

true mostra legendas; false as oculta enquanto o streaming continua.

Alterar visibilidade › Respostas

Sucesso

Sessão atual e configurações compartilhadas da igreja. Todos os campos estão presentes, inclusive quando ocioso.

StreamingStatus

streaming

boolean · obrigatório

true durante uma sessão ativa, incluindo inicialização, reconexões e desligamento. Não confirma que o áudio está chegando.

sessionId

string | null · obrigatório

ID da sessão atual; null enquanto ocioso.

startedAt

string | null · date-time · obrigatório

Hora de início da sessão atual; null enquanto ocioso.

deadlineAt

string | null · date-time · obrigatório

Hora de parada automática; null enquanto ocioso ou se nenhum prazo está registrado.

speakerLanguage

string | null · obrigatório

Código do idioma do locutor atual; null enquanto ocioso.

targetLanguages

string[] · obrigatório

Códigos dos idiomas de tradução atuais; vazio enquanto ocioso.

voice

string · enum · obrigatório

Voz da tradução, inclusive enquanto ocioso.

Valores do enumeração:

male

female

visible

boolean · obrigatório

true mostra legendas; false as oculta. Também se aplica enquanto ocioso.

publisher

object | null · obrigatório

Dispositivo Kaleo Connect ou navegador que envia áudio; null enquanto ocioso.

phase

string · enum · obrigatório

Estágio da sessão; ocioso significa que nenhuma sessão está ativa.

Valores do enumeração:

idle

starting

streaming

reconnecting

ending

object · obrigatório

Padrões da igreja para o próximo início manual. Substituições da sessão ativa não alteram esses valores.

PATCH/v1/church/{churchId}/streaming/visibility

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/visibility \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "visible": false
}'

Exemplo de corpo da requisição

{
  "visible": false
}

json

application/json

Exemplos de respostas

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "male",
  "visible": false,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Limpar legendas

POST

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/captions/clear

Bearer (API key)

Limpe o feed de legendas atual. Nenhum corpo de solicitação é necessário.

Limpar legendas › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

Limpar legendas › Respostas

Sucesso

Sessão atual e configurações compartilhadas da igreja. Todos os campos estão presentes, inclusive quando ocioso.

StreamingStatus

streaming

boolean · obrigatório

true durante uma sessão ativa, incluindo inicialização, reconexões e desligamento. Não confirma que o áudio está chegando.

sessionId

string | null · obrigatório

ID da sessão atual; null enquanto ocioso.

startedAt

string | null · date-time · obrigatório

Hora de início da sessão atual; null enquanto ocioso.

deadlineAt

string | null · date-time · obrigatório

Hora de parada automática; null enquanto ocioso ou se nenhum prazo está registrado.

speakerLanguage

string | null · obrigatório

Código do idioma do locutor atual; null enquanto ocioso.

targetLanguages

string[] · obrigatório

Códigos dos idiomas de tradução atuais; vazio enquanto ocioso.

voice

string · enum · obrigatório

Voz da tradução, inclusive enquanto ocioso.

Valores do enumeração:

male

female

visible

boolean · obrigatório

true mostra legendas; false as oculta. Também se aplica enquanto ocioso.

publisher

object | null · obrigatório

Dispositivo Kaleo Connect ou navegador que envia áudio; null enquanto ocioso.

phase

string · enum · obrigatório

Estágio da sessão; ocioso significa que nenhuma sessão está ativa.

Valores do enumeração:

idle

starting

streaming

reconnecting

ending

object · obrigatório

Padrões da igreja para o próximo início manual. Substituições da sessão ativa não alteram esses valores.

POST/v1/church/{churchId}/streaming/captions/clear

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/captions/clear \
  --request POST \
  --header 'Authorization: Bearer <token>'

Exemplos de respostas

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "male",
  "visible": true,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Alterar prazo de parada automática

PATCH

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/deadline

Bearer (API key)

Defina o tempo de parada automática para uma sessão ativa. Retorna o status atualizado do streaming.

Alterar prazo de parada automática › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

Alterar prazo de parada automática › Corpo da requisição

ChangeDeadline

deadlineAt

string · date-time · obrigatório

Hora futura de parada automática com Z ou deslocamento de fuso horário. Não mais tarde que seis horas após startedAt.

Alterar prazo de parada automática › Respostas

Sucesso

Sessão atual e configurações compartilhadas da igreja. Todos os campos estão presentes, inclusive quando ocioso.

StreamingStatus

streaming

boolean · obrigatório

true durante uma sessão ativa, incluindo inicialização, reconexões e desligamento. Não confirma que o áudio está chegando.

sessionId

string | null · obrigatório

ID da sessão atual; null enquanto ocioso.

startedAt

string | null · date-time · obrigatório

Hora de início da sessão atual; null enquanto ocioso.

deadlineAt

string | null · date-time · obrigatório

Hora de parada automática; null enquanto ocioso ou se nenhum prazo está registrado.

speakerLanguage

string | null · obrigatório

Código do idioma do locutor atual; null enquanto ocioso.

targetLanguages

string[] · obrigatório

Códigos dos idiomas de tradução atuais; vazio enquanto ocioso.

voice

string · enum · obrigatório

Voz da tradução, inclusive enquanto ocioso.

Valores do enumeração:

male

female

visible

boolean · obrigatório

true mostra legendas; false as oculta. Também se aplica enquanto ocioso.

publisher

object | null · obrigatório

Dispositivo Kaleo Connect ou navegador que envia áudio; null enquanto ocioso.

phase

string · enum · obrigatório

Estágio da sessão; ocioso significa que nenhuma sessão está ativa.

Valores do enumeração:

idle

starting

streaming

reconnecting

ending

object · obrigatório

Padrões da igreja para o próximo início manual. Substituições da sessão ativa não alteram esses valores.

PATCH/v1/church/{churchId}/streaming/deadline

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/deadline \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "deadlineAt": "2026-10-08T16:00:00Z"
}'

Exemplo de corpo da requisição

{
  "deadlineAt": "2026-10-08T16:00:00Z"
}

json

application/json

Exemplos de respostas

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "male",
  "visible": true,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Ajustar tempo de parada automática

POST

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/deadline/adjust

Bearer (API key)

Adicione ou subtraia tempo de parada automática. Enquanto ocioso, altere a duração para o próximo início manual. Enquanto transmitindo, altere o prazo atual. Cada solicitação aplica um ajuste separado.

Ajustar tempo de parada automática › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

Ajustar tempo de parada automática › Corpo da requisição

AdjustDeadline

deltaSeconds

integer · min: -21600 · max: 21600 · obrigatório

Segundos para adicionar à duração ociosa ou prazo atual; valores negativos subtraem. Não pode ser 0. Duração ociosa: 60–21600 segundos. Prazo ao vivo: futuro, dentro de seis horas de startedAt.

Ajustar tempo de parada automática › Respostas

Sucesso

Sessão atual e configurações compartilhadas da igreja. Todos os campos estão presentes, inclusive quando ocioso.

StreamingStatus

streaming

boolean · obrigatório

true durante uma sessão ativa, incluindo inicialização, reconexões e desligamento. Não confirma que o áudio está chegando.

sessionId

string | null · obrigatório

ID da sessão atual; null enquanto ocioso.

startedAt

string | null · date-time · obrigatório

Hora de início da sessão atual; null enquanto ocioso.

deadlineAt

string | null · date-time · obrigatório

Hora de parada automática; null enquanto ocioso ou se nenhum prazo está registrado.

speakerLanguage

string | null · obrigatório

Código do idioma do locutor atual; null enquanto ocioso.

targetLanguages

string[] · obrigatório

Códigos dos idiomas de tradução atuais; vazio enquanto ocioso.

voice

string · enum · obrigatório

Voz da tradução, inclusive enquanto ocioso.

Valores do enumeração:

male

female

visible

boolean · obrigatório

true mostra legendas; false as oculta. Também se aplica enquanto ocioso.

publisher

object | null · obrigatório

Dispositivo Kaleo Connect ou navegador que envia áudio; null enquanto ocioso.

phase

string · enum · obrigatório

Estágio da sessão; ocioso significa que nenhuma sessão está ativa.

Valores do enumeração:

idle

starting

streaming

reconnecting

ending

object · obrigatório

Padrões da igreja para o próximo início manual. Substituições da sessão ativa não alteram esses valores.

POST/v1/church/{churchId}/streaming/deadline/adjust

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/deadline/adjust \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "deltaSeconds": 120
}'

Exemplo de corpo da requisição

{
  "deltaSeconds": 120
}

json

application/json

Exemplos de respostas

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "male",
  "visible": true,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Dispositivos Sessões

API Kaleo

Streaming

Baixar esquema

Obter status de streaming

GET

https://babel.withkaleo.com

/v1/church/{churchId}/streaming

Bearer (API key)

Leia a sessão atual e as configurações compartilhadas da igreja. Todos os campos estão presentes, inclusive quando ocioso.

Obter status de streaming › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

Obter status de streaming › Respostas

Sucesso

Sessão atual e configurações compartilhadas da igreja. Todos os campos estão presentes, inclusive quando ocioso.

StreamingStatus

streaming

boolean · obrigatório

true durante uma sessão ativa, incluindo inicialização, reconexões e desligamento. Não confirma que o áudio está chegando.

sessionId

string | null · obrigatório

ID da sessão atual; null enquanto ocioso.

startedAt

string | null · date-time · obrigatório

Hora de início da sessão atual; null enquanto ocioso.

deadlineAt

string | null · date-time · obrigatório

Hora de parada automática; null enquanto ocioso ou se nenhum prazo está registrado.

speakerLanguage

string | null · obrigatório

Código do idioma do locutor atual; null enquanto ocioso.

targetLanguages

string[] · obrigatório

Códigos dos idiomas de tradução atuais; vazio enquanto ocioso.

voice

string · enum · obrigatório

Voz da tradução, inclusive enquanto ocioso.

Valores do enumeração:

male

female

visible

boolean · obrigatório

true mostra legendas; false as oculta. Também se aplica enquanto ocioso.

publisher

object | null · obrigatório

Dispositivo Kaleo Connect ou navegador que envia áudio; null enquanto ocioso.

phase

string · enum · obrigatório

Estágio da sessão; ocioso significa que nenhuma sessão está ativa.

Valores do enumeração:

idle

starting

streaming

reconnecting

ending

object · obrigatório

Padrões da igreja para o próximo início manual. Substituições da sessão ativa não alteram esses valores.

Iniciar streaming

POST

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/start

Bearer (API key)

Iniciar streaming › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

Iniciar streaming › Corpo da requisição opcional

StartStreaming

deviceId

string

object

Configurações apenas para esta sessão. Campos omitidos usam padrões salvos.

Iniciar streaming › Respostas

Sucesso

Sessão atual e configurações compartilhadas da igreja. Todos os campos estão presentes, inclusive quando ocioso.

StreamingStatus

streaming

boolean · obrigatório

true durante uma sessão ativa, incluindo inicialização, reconexões e desligamento. Não confirma que o áudio está chegando.

sessionId

string | null · obrigatório

ID da sessão atual; null enquanto ocioso.

startedAt

string | null · date-time · obrigatório

Hora de início da sessão atual; null enquanto ocioso.

deadlineAt

string | null · date-time · obrigatório

Hora de parada automática; null enquanto ocioso ou se nenhum prazo está registrado.

speakerLanguage

string | null · obrigatório

Código do idioma do locutor atual; null enquanto ocioso.

targetLanguages

string[] · obrigatório

Códigos dos idiomas de tradução atuais; vazio enquanto ocioso.

voice

string · enum · obrigatório

Voz da tradução, inclusive enquanto ocioso.

Valores do enumeração:

male

female

visible

boolean · obrigatório

true mostra legendas; false as oculta. Também se aplica enquanto ocioso.

publisher

object | null · obrigatório

Dispositivo Kaleo Connect ou navegador que envia áudio; null enquanto ocioso.

phase

string · enum · obrigatório

Estágio da sessão; ocioso significa que nenhuma sessão está ativa.

Valores do enumeração:

idle

starting

streaming

reconnecting

ending

object · obrigatório

Padrões da igreja para o próximo início manual. Substituições da sessão ativa não alteram esses valores.

POST/v1/church/{churchId}/streaming/start

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/start \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Exemplo de corpo da requisição

{}

json

application/json

Exemplos de respostas

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "male",
  "visible": true,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Parar streaming

POST

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/stop

Bearer (API key)

Pare a sessão de streaming atual. Nenhum corpo de solicitação é necessário.

Parar streaming › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

Parar streaming › Respostas

Sucesso

Sessão atual e configurações compartilhadas da igreja. Todos os campos estão presentes, inclusive quando ocioso.

StreamingStatus

streaming

boolean · obrigatório

true durante uma sessão ativa, incluindo inicialização, reconexões e desligamento. Não confirma que o áudio está chegando.

sessionId

string | null · obrigatório

ID da sessão atual; null enquanto ocioso.

startedAt

string | null · date-time · obrigatório

Hora de início da sessão atual; null enquanto ocioso.

deadlineAt

string | null · date-time · obrigatório

Hora de parada automática; null enquanto ocioso ou se nenhum prazo está registrado.

speakerLanguage

string | null · obrigatório

Código do idioma do locutor atual; null enquanto ocioso.

targetLanguages

string[] · obrigatório

Códigos dos idiomas de tradução atuais; vazio enquanto ocioso.

voice

string · enum · obrigatório

Voz da tradução, inclusive enquanto ocioso.

Valores do enumeração:

male

female

visible

boolean · obrigatório

true mostra legendas; false as oculta. Também se aplica enquanto ocioso.

publisher

object | null · obrigatório

Dispositivo Kaleo Connect ou navegador que envia áudio; null enquanto ocioso.

phase

string · enum · obrigatório

Estágio da sessão; ocioso significa que nenhuma sessão está ativa.

Valores do enumeração:

idle

starting

streaming

reconnecting

ending

object · obrigatório

Padrões da igreja para o próximo início manual. Substituições da sessão ativa não alteram esses valores.

Alterar voz da tradução

PATCH

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/voice

Bearer (API key)

Altere a voz da tradução enquanto estiver ocioso ou transmitindo.

Alterar voz da tradução › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

Alterar voz da tradução › Corpo da requisição

ChangeVoice

voice

string · enum · obrigatório

Voz da tradução. Pode ser alterada enquanto ocioso ou transmitindo.

Valores do enumeração:

male

female

Alterar voz da tradução › Respostas

Sucesso

Sessão atual e configurações compartilhadas da igreja. Todos os campos estão presentes, inclusive quando ocioso.

StreamingStatus

streaming

boolean · obrigatório

true durante uma sessão ativa, incluindo inicialização, reconexões e desligamento. Não confirma que o áudio está chegando.

sessionId

string | null · obrigatório

ID da sessão atual; null enquanto ocioso.

startedAt

string | null · date-time · obrigatório

Hora de início da sessão atual; null enquanto ocioso.

deadlineAt

string | null · date-time · obrigatório

Hora de parada automática; null enquanto ocioso ou se nenhum prazo está registrado.

speakerLanguage

string | null · obrigatório

Código do idioma do locutor atual; null enquanto ocioso.

targetLanguages

string[] · obrigatório

Códigos dos idiomas de tradução atuais; vazio enquanto ocioso.

voice

string · enum · obrigatório

Voz da tradução, inclusive enquanto ocioso.

Valores do enumeração:

male

female

visible

boolean · obrigatório

true mostra legendas; false as oculta. Também se aplica enquanto ocioso.

publisher

object | null · obrigatório

Dispositivo Kaleo Connect ou navegador que envia áudio; null enquanto ocioso.

phase

string · enum · obrigatório

Estágio da sessão; ocioso significa que nenhuma sessão está ativa.

Valores do enumeração:

idle

starting

streaming

reconnecting

ending

object · obrigatório

Padrões da igreja para o próximo início manual. Substituições da sessão ativa não alteram esses valores.

PATCH/v1/church/{churchId}/streaming/voice

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/voice \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "voice": "female"
}'

Exemplo de corpo da requisição

{
  "voice": "female"
}

json

application/json

Exemplos de respostas

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "female",
  "visible": true,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Alterar visibilidade

PATCH

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/visibility

Bearer (API key)

Mostrar ou ocultar legendas enquanto estiver ocioso ou transmitindo. Ocultar legendas não interrompe a sessão.

Alterar visibilidade › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

Alterar visibilidade › Corpo da requisição

ChangeVisibility

visible

boolean · obrigatório

true mostra legendas; false as oculta enquanto o streaming continua.

Alterar visibilidade › Respostas

Sucesso

Sessão atual e configurações compartilhadas da igreja. Todos os campos estão presentes, inclusive quando ocioso.

StreamingStatus

streaming

boolean · obrigatório

true durante uma sessão ativa, incluindo inicialização, reconexões e desligamento. Não confirma que o áudio está chegando.

sessionId

string | null · obrigatório

ID da sessão atual; null enquanto ocioso.

startedAt

string | null · date-time · obrigatório

Hora de início da sessão atual; null enquanto ocioso.

deadlineAt

string | null · date-time · obrigatório

Hora de parada automática; null enquanto ocioso ou se nenhum prazo está registrado.

speakerLanguage

string | null · obrigatório

Código do idioma do locutor atual; null enquanto ocioso.

targetLanguages

string[] · obrigatório

Códigos dos idiomas de tradução atuais; vazio enquanto ocioso.

voice

string · enum · obrigatório

Voz da tradução, inclusive enquanto ocioso.

Valores do enumeração:

male

female

visible

boolean · obrigatório

true mostra legendas; false as oculta. Também se aplica enquanto ocioso.

publisher

object | null · obrigatório

Dispositivo Kaleo Connect ou navegador que envia áudio; null enquanto ocioso.

phase

string · enum · obrigatório

Estágio da sessão; ocioso significa que nenhuma sessão está ativa.

Valores do enumeração:

idle

starting

streaming

reconnecting

ending

object · obrigatório

Padrões da igreja para o próximo início manual. Substituições da sessão ativa não alteram esses valores.

PATCH/v1/church/{churchId}/streaming/visibility

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/visibility \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "visible": false
}'

Exemplo de corpo da requisição

{
  "visible": false
}

json

application/json

Exemplos de respostas

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "male",
  "visible": false,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Limpar legendas

POST

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/captions/clear

Bearer (API key)

Limpe o feed de legendas atual. Nenhum corpo de solicitação é necessário.

Limpar legendas › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

Limpar legendas › Respostas

Sucesso

Sessão atual e configurações compartilhadas da igreja. Todos os campos estão presentes, inclusive quando ocioso.

StreamingStatus

streaming

boolean · obrigatório

true durante uma sessão ativa, incluindo inicialização, reconexões e desligamento. Não confirma que o áudio está chegando.

sessionId

string | null · obrigatório

ID da sessão atual; null enquanto ocioso.

startedAt

string | null · date-time · obrigatório

Hora de início da sessão atual; null enquanto ocioso.

deadlineAt

string | null · date-time · obrigatório

Hora de parada automática; null enquanto ocioso ou se nenhum prazo está registrado.

speakerLanguage

string | null · obrigatório

Código do idioma do locutor atual; null enquanto ocioso.

targetLanguages

string[] · obrigatório

Códigos dos idiomas de tradução atuais; vazio enquanto ocioso.

voice

string · enum · obrigatório

Voz da tradução, inclusive enquanto ocioso.

Valores do enumeração:

male

female

visible

boolean · obrigatório

true mostra legendas; false as oculta. Também se aplica enquanto ocioso.

publisher

object | null · obrigatório

Dispositivo Kaleo Connect ou navegador que envia áudio; null enquanto ocioso.

phase

string · enum · obrigatório

Estágio da sessão; ocioso significa que nenhuma sessão está ativa.

Valores do enumeração:

idle

starting

streaming

reconnecting

ending

object · obrigatório

Padrões da igreja para o próximo início manual. Substituições da sessão ativa não alteram esses valores.

POST/v1/church/{churchId}/streaming/captions/clear

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/captions/clear \
  --request POST \
  --header 'Authorization: Bearer <token>'

Exemplos de respostas

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "male",
  "visible": true,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Alterar prazo de parada automática

PATCH

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/deadline

Bearer (API key)

Defina o tempo de parada automática para uma sessão ativa. Retorna o status atualizado do streaming.

Alterar prazo de parada automática › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

Alterar prazo de parada automática › Corpo da requisição

ChangeDeadline

deadlineAt

string · date-time · obrigatório

Hora futura de parada automática com Z ou deslocamento de fuso horário. Não mais tarde que seis horas após startedAt.

Alterar prazo de parada automática › Respostas

Sucesso

Sessão atual e configurações compartilhadas da igreja. Todos os campos estão presentes, inclusive quando ocioso.

StreamingStatus

streaming

boolean · obrigatório

true durante uma sessão ativa, incluindo inicialização, reconexões e desligamento. Não confirma que o áudio está chegando.

sessionId

string | null · obrigatório

ID da sessão atual; null enquanto ocioso.

startedAt

string | null · date-time · obrigatório

Hora de início da sessão atual; null enquanto ocioso.

deadlineAt

string | null · date-time · obrigatório

Hora de parada automática; null enquanto ocioso ou se nenhum prazo está registrado.

speakerLanguage

string | null · obrigatório

Código do idioma do locutor atual; null enquanto ocioso.

targetLanguages

string[] · obrigatório

Códigos dos idiomas de tradução atuais; vazio enquanto ocioso.

voice

string · enum · obrigatório

Voz da tradução, inclusive enquanto ocioso.

Valores do enumeração:

male

female

visible

boolean · obrigatório

true mostra legendas; false as oculta. Também se aplica enquanto ocioso.

publisher

object | null · obrigatório

Dispositivo Kaleo Connect ou navegador que envia áudio; null enquanto ocioso.

phase

string · enum · obrigatório

Estágio da sessão; ocioso significa que nenhuma sessão está ativa.

Valores do enumeração:

idle

starting

streaming

reconnecting

ending

object · obrigatório

Padrões da igreja para o próximo início manual. Substituições da sessão ativa não alteram esses valores.

PATCH/v1/church/{churchId}/streaming/deadline

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/deadline \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "deadlineAt": "2026-10-08T16:00:00Z"
}'

Exemplo de corpo da requisição

{
  "deadlineAt": "2026-10-08T16:00:00Z"
}

json

application/json

Exemplos de respostas

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "male",
  "visible": true,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Ajustar tempo de parada automática

POST

https://babel.withkaleo.com

/v1/church/{churchId}/streaming/deadline/adjust

Bearer (API key)

Ajustar tempo de parada automática › Parâmetros de caminho

churchId

string · obrigatório

O ID da sua igreja. Copie-o da página API (em Integrações) no seu painel.

Ajustar tempo de parada automática › Corpo da requisição

AdjustDeadline

deltaSeconds

integer · min: -21600 · max: 21600 · obrigatório

Ajustar tempo de parada automática › Respostas

Sucesso

Sessão atual e configurações compartilhadas da igreja. Todos os campos estão presentes, inclusive quando ocioso.

StreamingStatus

streaming

boolean · obrigatório

true durante uma sessão ativa, incluindo inicialização, reconexões e desligamento. Não confirma que o áudio está chegando.

sessionId

string | null · obrigatório

ID da sessão atual; null enquanto ocioso.

startedAt

string | null · date-time · obrigatório

Hora de início da sessão atual; null enquanto ocioso.

deadlineAt

string | null · date-time · obrigatório

Hora de parada automática; null enquanto ocioso ou se nenhum prazo está registrado.

speakerLanguage

string | null · obrigatório

Código do idioma do locutor atual; null enquanto ocioso.

targetLanguages

string[] · obrigatório

Códigos dos idiomas de tradução atuais; vazio enquanto ocioso.

voice

string · enum · obrigatório

Voz da tradução, inclusive enquanto ocioso.

Valores do enumeração:

male

female

visible

boolean · obrigatório

true mostra legendas; false as oculta. Também se aplica enquanto ocioso.

publisher

object | null · obrigatório

Dispositivo Kaleo Connect ou navegador que envia áudio; null enquanto ocioso.

phase

string · enum · obrigatório

Estágio da sessão; ocioso significa que nenhuma sessão está ativa.

Valores do enumeração:

idle

starting

streaming

reconnecting

ending

object · obrigatório

Padrões da igreja para o próximo início manual. Substituições da sessão ativa não alteram esses valores.

POST/v1/church/{churchId}/streaming/deadline/adjust

curl https://babel.withkaleo.com/v1/church/:churchId/streaming/deadline/adjust \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "deltaSeconds": 120
}'

Exemplo de corpo da requisição

{
  "deltaSeconds": 120
}

json

application/json

Exemplos de respostas

{
  "streaming": true,
  "sessionId": "00000000-0000-4000-8000-000000000001",
  "startedAt": "2026-10-08T14:00:00.000Z",
  "deadlineAt": "2026-10-08T16:00:00.000Z",
  "speakerLanguage": "en",
  "targetLanguages": [
    "fr-FR"
  ],
  "voice": "male",
  "visible": true,
  "publisher": {
    "kind": "connect",
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Sanctuary Mac"
  },
  "phase": "streaming",
  "streamSettings": {
    "revision": 4,
    "settings": {
      "speakerLanguage": "en",
      "targetLanguages": [
        "fr-FR"
      ],
      "duration": 3600
    }
  }
}

json

application/json

Dispositivos Sessões