--- title: "Voz em Tempo Real para Agentes e Chats" description: "Fala de baixa latência para agentes, chatbots e atendimento, pela metade do custo. Preço por faixa, a partir de R$ 0,15 por chamada." lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/360cdbc3-dec0-11f1-98bb-bc24118aba26 markdown: https://doc.apibrasil.io/apis/creditos/360cdbc3-dec0-11f1-98bb-bc24118aba26.md source: apibrasil-documentation --- # Voz em Tempo Real para Agentes e Chats > Fala de baixa latência para agentes, chatbots e atendimento, pela metade do custo. Preço por faixa, a partir de R$ 0,15 por chamada. - **Categoria:** Voz e Áudio com IA - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 0,15 por consulta - **Limite:** 990.000 por mês - **Cadastro:** CPF ou CNPJ - **Versão:** v2 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/360cdbc3-dec0-11f1-98bb-bc24118aba26/openapi.json ## Como chamar **Endereço base:** `https://gateway.apibrasil.io/api/v2` Autenticação: cabeçalho `Authorization: Bearer `. Nada além disso. Com `homolog: true` no corpo, o gateway responde de uma base fixa, com a forma real da resposta, e não cobra. O CPF 00000000000 é dessa base e não é de ninguém: use-o nos testes, nunca em produção. ## Endpoints (5 endpoints) **Sumário** 1. `POST /consulta/voz-tempo-real/credits` 2. `POST /consulta/voz-tempo-real/credits` 3. `POST /consulta/voz-tempo-real/credits` 4. `POST /consulta/voz-tempo-real/credits` 5. `POST /consulta/voz-tempo-real/credits` ### 1. POST /consulta/voz-tempo-real/credits ⚠️ Aviso: a chamada é cobrada quando a lista é devolvida (HTTP 200). Filtro com valor fora da lista é recusado sem cobrança. Listar vozes disponíveis: Lista as vozes que podem ir no campo voz: as do catálogo, em português do Brasil, e as vozes próprias da sua conta. Cada voz traz o id (o valor do campo voz), o nome, o sexo, a faixa de idade, o estilo, o uso indicado, a origem (catalogo ou propria) e o link de uma amostra. A resposta traz também as emoções e os formatos aceitos na geração de fala. Envie um POST com tipo=voz-tempo-real-vozes e: - sexo (opcional, texto): Filtra pelo sexo da voz: feminino, masculino ou neutro. - idade (opcional, texto): Filtra pela faixa de idade da voz: jovem, meia_idade ou idoso. - estilo (opcional, texto): Filtra pelo estilo da voz, com um dos valores que a própria lista devolve no campo estilo. - uso (opcional, texto): Filtra pelo uso indicado, com um dos valores que a própria lista devolve no campo uso. - busca (opcional, texto): Parte do nome da voz, sem diferença entre maiúsculas e minúsculas. Respostas de erro (nenhuma é cobrada): - HTTP 400: um filtro veio com valor fora da lista (sexo, idade) ou vazio - HTTP 502: o serviço de voz respondeu fora do esperado - HTTP 503: o serviço de voz está indisponível ou no limite de chamadas simultâneas; tente de novo em alguns segundos - HTTP 504: o serviço de voz não respondeu dentro do tempo limite Preço: R$ 0,01 por chamada. Em homologação (homolog=true), sem cobrança, a resposta traz dados fictícios no mesmo formato. O áudio é gerado por inteligência artificial e leva uma marca d'água inaudível, que não pode ser removida. Avise quem ouve que a voz é sintética quando a lei exigir ou quando a falta do aviso puder enganar. O texto é processado em servidores nos Estados Unidos. Não envie no texto dado de saúde, número de cartão ou número de documento oficial, como o CPF. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/voz-tempo-real/credits` - **Versão da rota:** v2 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "voz-tempo-real-vozes", "sexo": "feminino", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/voz-tempo-real/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"voz-tempo-real-vozes","sexo":"feminino","homolog":true}' ``` Este endpoint aceita `homolog: true` no corpo: a resposta volta com dados válidos, `api_limit_for` igual a `homolog` e sem tarifação. **Resposta de exemplo, do catálogo** ```json { "user": { "first_name": "[omitido]", "email": "[omitido]", "cellphone": "[omitido]", "notification": "yes" }, "balance": "399,990", "balance_before": "400,000", "tax": "0,010", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 0,01.", "valor_consulta": 0.01, "api_limit_for": "credit", "homolog": false, "data": { "tipo": "voz-tempo-real-vozes", "vozes": [ { "id": "AbCdEfGhIj0123456789", "nome": "Ana", "sexo": "feminino", "idade": "jovem", "estilo": "acolhedora", "uso": "atendimento", "origem": "catalogo", "amostra_url": "https://gateway.apibrasil.io/proxy/?u=https%3A%2F%2Fvoz-tempo-real.apidocumentos.com.br%2Famostra%2FAbCdEfGhIj0123456789" }, { "id": "KlMnOpQrSt9876543210", "nome": "Minha voz de atendimento", "sexo": "feminino", "idade": "meia_idade", "estilo": "profissional", "uso": "atendimento", "origem": "propria", "amostra_url": "https://gateway.apibrasil.io/proxy/?u=https%3A%2F%2Fvoz-tempo-real.apidocumentos.com.br%2Famostra%2FKlMnOpQrSt9876543210" } ], "total": 2, "emocoes": [ "alegre", "animado", "calmo", "triste", "serio", "empatico", "profissional", "tranquilizador", "curioso", "surpreso", "irritado", "sarcastico", "sussurrando", "rindo" ], "formatos": [ "mp3", "mp3_leve", "ogg", "wav", "telefonia" ] } } ``` ### 2. POST /consulta/voz-tempo-real/credits ⚠️ Aviso: a chamada é cobrada quando o áudio é gerado e o link é devolvido (HTTP 200). Texto acima de 250 caracteres, voz que não existe ou não é da sua conta, texto barrado pela moderação e falha na geração não são cobrados. Gerar fala de até 250 caracteres: Gera o áudio do texto com a voz escolhida e devolve o link para download (audio_url), o tipo do arquivo (tipo_mime), o tamanho em bytes, a duração em segundos, a validade do link (expira_em), quantos caracteres contaram na faixa (caracteres, já com a emoção e as marcações), a voz, o formato e o modelo de voz usado. Este tipo aceita texto de até 250 caracteres. Envie um POST com tipo=voz-tempo-real-250 e: - texto (obrigatório, texto): O que vai ser falado: de 1 a 250 caracteres neste tipo, contando a marcação da emoção e as marcações entre colchetes que você escrever no texto (por exemplo [laughs] ou [whispers]). - voz (obrigatório, texto): O id da voz, tirado da lista do tipo voz-tempo-real-vozes (catálogo ou voz própria da sua conta). - emocao (opcional, texto): alegre, animado, calmo, triste, serio, empatico, profissional, tranquilizador, curioso, surpreso, irritado, sarcastico, sussurrando ou rindo. Vira uma marcação no início do texto e conta no tamanho. - estabilidade (opcional, decimal): De 0 a 1, padrão 0.5. Mais alto deixa a fala mais constante; mais baixo, mais expressiva. - similaridade (opcional, decimal): De 0 a 1, padrão 0.75: o quanto a fala se mantém fiel ao timbre da voz escolhida. - formato (opcional, texto): mp3 (padrão, 44,1 kHz e 128 kbps), mp3_leve (22,05 kHz e 32 kbps), ogg (Opus, o formato da nota de voz do WhatsApp), wav (24 kHz) ou telefonia (µ-law a 8 kHz, para URA). - semente (opcional, inteiro): De 0 a 4294967295. Repetir a semente com o mesmo texto e os mesmos ajustes tende a gerar o mesmo áudio. - variacao (opcional, inteiro): De 0 a 999999, não muda o áudio por si: trocar o número faz o pedido deixar de ser idêntico a um anterior e gera outra versão, em vez de devolver a resposta guardada. Respostas de erro (nenhuma é cobrada): - HTTP 400: texto vazio ou acima de 250 caracteres (a mensagem diz o tamanho e qual tipo comporta), voz ausente, ou emoção, formato, estabilidade, similaridade ou semente fora da lista ou da faixa - HTTP 404: a voz não existe no catálogo e não é uma voz da sua conta - HTTP 409: um pedido idêntico ainda está em andamento; repita em instantes - HTTP 422: o texto foi barrado pela moderação do serviço de voz - HTTP 502: o serviço de voz respondeu sem o áudio ou com erro - HTTP 503: o serviço de voz está indisponível ou no limite de chamadas simultâneas; tente de novo em alguns segundos - HTTP 504: a geração passou do tempo limite Preço: R$ 0,15 por chamada. Em homologação (homolog=true), sem cobrança, a resposta traz dados fictícios no mesmo formato. O áudio é gerado por inteligência artificial e leva uma marca d'água inaudível, que não pode ser removida. Avise quem ouve que a voz é sintética quando a lei exigir ou quando a falta do aviso puder enganar. O texto é processado em servidores nos Estados Unidos. Não envie no texto dado de saúde, número de cartão ou número de documento oficial, como o CPF. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/voz-tempo-real/credits` - **Versão da rota:** v2 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "voz-tempo-real-250", "texto": "Olá! Seu pedido foi confirmado e chega amanhã.", "voz": "AbCdEfGhIj0123456789", "emocao": "alegre", "formato": "mp3", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/voz-tempo-real/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"voz-tempo-real-250","texto":"Olá! Seu pedido foi confirmado e chega amanhã.","voz":"AbCdEfGhIj0123456789","emocao":"alegre","formato":"mp3","homolog":true}' ``` Este endpoint aceita `homolog: true` no corpo: a resposta volta com dados válidos, `api_limit_for` igual a `homolog` e sem tarifação. **Resposta de exemplo, do catálogo** ```json { "user": { "first_name": "[omitido]", "email": "[omitido]", "cellphone": "[omitido]", "notification": "yes" }, "balance": "399,850", "balance_before": "400,000", "tax": "0,150", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 0,15.", "valor_consulta": 0.15, "api_limit_for": "credit", "homolog": false, "data": { "tipo": "voz-tempo-real-250", "audio_url": "https://gateway.apibrasil.io/proxy/?u=https%3A%2F%2Fvoz-tempo-real.apidocumentos.com.br%2Faudio%2F0f1e2d3c-4b5a-4978-8796-a5b4c3d2e1f0", "tipo_mime": "audio/mpeg", "tamanho_bytes": 52480, "duracao_segundos": 3.28, "expira_em": "2026-11-13T15:00:00Z", "caracteres": 54, "voz": "AbCdEfGhIj0123456789", "formato": "mp3", "modelo": "v4" } } ``` ### 3. POST /consulta/voz-tempo-real/credits ⚠️ Aviso: a chamada é cobrada quando o áudio é gerado e o link é devolvido (HTTP 200). Texto acima de 500 caracteres, voz que não existe ou não é da sua conta, texto barrado pela moderação e falha na geração não são cobrados. Gerar fala de até 500 caracteres: Gera o áudio do texto com a voz escolhida e devolve o link para download (audio_url), o tipo do arquivo (tipo_mime), o tamanho em bytes, a duração em segundos, a validade do link (expira_em), quantos caracteres contaram na faixa (caracteres, já com a emoção e as marcações), a voz, o formato e o modelo de voz usado. Este tipo aceita texto de até 500 caracteres. Envie um POST com tipo=voz-tempo-real-500 e: - texto (obrigatório, texto): O que vai ser falado: de 1 a 500 caracteres neste tipo, contando a marcação da emoção e as marcações entre colchetes que você escrever no texto (por exemplo [laughs] ou [whispers]). - voz (obrigatório, texto): O id da voz, tirado da lista do tipo voz-tempo-real-vozes (catálogo ou voz própria da sua conta). - emocao (opcional, texto): alegre, animado, calmo, triste, serio, empatico, profissional, tranquilizador, curioso, surpreso, irritado, sarcastico, sussurrando ou rindo. Vira uma marcação no início do texto e conta no tamanho. - estabilidade (opcional, decimal): De 0 a 1, padrão 0.5. Mais alto deixa a fala mais constante; mais baixo, mais expressiva. - similaridade (opcional, decimal): De 0 a 1, padrão 0.75: o quanto a fala se mantém fiel ao timbre da voz escolhida. - formato (opcional, texto): mp3 (padrão, 44,1 kHz e 128 kbps), mp3_leve (22,05 kHz e 32 kbps), ogg (Opus, o formato da nota de voz do WhatsApp), wav (24 kHz) ou telefonia (µ-law a 8 kHz, para URA). - semente (opcional, inteiro): De 0 a 4294967295. Repetir a semente com o mesmo texto e os mesmos ajustes tende a gerar o mesmo áudio. - variacao (opcional, inteiro): De 0 a 999999, não muda o áudio por si: trocar o número faz o pedido deixar de ser idêntico a um anterior e gera outra versão, em vez de devolver a resposta guardada. Respostas de erro (nenhuma é cobrada): - HTTP 400: texto vazio ou acima de 500 caracteres (a mensagem diz o tamanho e qual tipo comporta), voz ausente, ou emoção, formato, estabilidade, similaridade ou semente fora da lista ou da faixa - HTTP 404: a voz não existe no catálogo e não é uma voz da sua conta - HTTP 409: um pedido idêntico ainda está em andamento; repita em instantes - HTTP 422: o texto foi barrado pela moderação do serviço de voz - HTTP 502: o serviço de voz respondeu sem o áudio ou com erro - HTTP 503: o serviço de voz está indisponível ou no limite de chamadas simultâneas; tente de novo em alguns segundos - HTTP 504: a geração passou do tempo limite Preço: R$ 0,30 por chamada. Em homologação (homolog=true), sem cobrança, a resposta traz dados fictícios no mesmo formato. O áudio é gerado por inteligência artificial e leva uma marca d'água inaudível, que não pode ser removida. Avise quem ouve que a voz é sintética quando a lei exigir ou quando a falta do aviso puder enganar. O texto é processado em servidores nos Estados Unidos. Não envie no texto dado de saúde, número de cartão ou número de documento oficial, como o CPF. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/voz-tempo-real/credits` - **Versão da rota:** v2 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "voz-tempo-real-500", "texto": "Olá! Seu pedido foi confirmado e chega amanhã.", "voz": "AbCdEfGhIj0123456789", "emocao": "alegre", "formato": "mp3", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/voz-tempo-real/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"voz-tempo-real-500","texto":"Olá! Seu pedido foi confirmado e chega amanhã.","voz":"AbCdEfGhIj0123456789","emocao":"alegre","formato":"mp3","homolog":true}' ``` Este endpoint aceita `homolog: true` no corpo: a resposta volta com dados válidos, `api_limit_for` igual a `homolog` e sem tarifação. **Resposta de exemplo, do catálogo** ```json { "user": { "first_name": "[omitido]", "email": "[omitido]", "cellphone": "[omitido]", "notification": "yes" }, "balance": "399,700", "balance_before": "400,000", "tax": "0,300", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 0,30.", "valor_consulta": 0.3, "api_limit_for": "credit", "homolog": false, "data": { "tipo": "voz-tempo-real-500", "audio_url": "https://gateway.apibrasil.io/proxy/?u=https%3A%2F%2Fvoz-tempo-real.apidocumentos.com.br%2Faudio%2F0f1e2d3c-4b5a-4978-8796-a5b4c3d2e1f0", "tipo_mime": "audio/mpeg", "tamanho_bytes": 52480, "duracao_segundos": 3.28, "expira_em": "2026-11-13T15:00:00Z", "caracteres": 54, "voz": "AbCdEfGhIj0123456789", "formato": "mp3", "modelo": "v4" } } ``` ### 4. POST /consulta/voz-tempo-real/credits ⚠️ Aviso: a chamada é cobrada quando o áudio é gerado e o link é devolvido (HTTP 200). Texto acima de 1000 caracteres, voz que não existe ou não é da sua conta, texto barrado pela moderação e falha na geração não são cobrados. Gerar fala de até 1000 caracteres: Gera o áudio do texto com a voz escolhida e devolve o link para download (audio_url), o tipo do arquivo (tipo_mime), o tamanho em bytes, a duração em segundos, a validade do link (expira_em), quantos caracteres contaram na faixa (caracteres, já com a emoção e as marcações), a voz, o formato e o modelo de voz usado. Este tipo aceita texto de até 1000 caracteres. Envie um POST com tipo=voz-tempo-real-1000 e: - texto (obrigatório, texto): O que vai ser falado: de 1 a 1000 caracteres neste tipo, contando a marcação da emoção e as marcações entre colchetes que você escrever no texto (por exemplo [laughs] ou [whispers]). - voz (obrigatório, texto): O id da voz, tirado da lista do tipo voz-tempo-real-vozes (catálogo ou voz própria da sua conta). - emocao (opcional, texto): alegre, animado, calmo, triste, serio, empatico, profissional, tranquilizador, curioso, surpreso, irritado, sarcastico, sussurrando ou rindo. Vira uma marcação no início do texto e conta no tamanho. - estabilidade (opcional, decimal): De 0 a 1, padrão 0.5. Mais alto deixa a fala mais constante; mais baixo, mais expressiva. - similaridade (opcional, decimal): De 0 a 1, padrão 0.75: o quanto a fala se mantém fiel ao timbre da voz escolhida. - formato (opcional, texto): mp3 (padrão, 44,1 kHz e 128 kbps), mp3_leve (22,05 kHz e 32 kbps), ogg (Opus, o formato da nota de voz do WhatsApp), wav (24 kHz) ou telefonia (µ-law a 8 kHz, para URA). - semente (opcional, inteiro): De 0 a 4294967295. Repetir a semente com o mesmo texto e os mesmos ajustes tende a gerar o mesmo áudio. - variacao (opcional, inteiro): De 0 a 999999, não muda o áudio por si: trocar o número faz o pedido deixar de ser idêntico a um anterior e gera outra versão, em vez de devolver a resposta guardada. Respostas de erro (nenhuma é cobrada): - HTTP 400: texto vazio ou acima de 1000 caracteres (a mensagem diz o tamanho e qual tipo comporta), voz ausente, ou emoção, formato, estabilidade, similaridade ou semente fora da lista ou da faixa - HTTP 404: a voz não existe no catálogo e não é uma voz da sua conta - HTTP 409: um pedido idêntico ainda está em andamento; repita em instantes - HTTP 422: o texto foi barrado pela moderação do serviço de voz - HTTP 502: o serviço de voz respondeu sem o áudio ou com erro - HTTP 503: o serviço de voz está indisponível ou no limite de chamadas simultâneas; tente de novo em alguns segundos - HTTP 504: a geração passou do tempo limite Preço: R$ 0,60 por chamada. Em homologação (homolog=true), sem cobrança, a resposta traz dados fictícios no mesmo formato. O áudio é gerado por inteligência artificial e leva uma marca d'água inaudível, que não pode ser removida. Avise quem ouve que a voz é sintética quando a lei exigir ou quando a falta do aviso puder enganar. O texto é processado em servidores nos Estados Unidos. Não envie no texto dado de saúde, número de cartão ou número de documento oficial, como o CPF. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/voz-tempo-real/credits` - **Versão da rota:** v2 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "voz-tempo-real-1000", "texto": "Olá! Seu pedido foi confirmado e chega amanhã.", "voz": "AbCdEfGhIj0123456789", "emocao": "alegre", "formato": "mp3", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/voz-tempo-real/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"voz-tempo-real-1000","texto":"Olá! Seu pedido foi confirmado e chega amanhã.","voz":"AbCdEfGhIj0123456789","emocao":"alegre","formato":"mp3","homolog":true}' ``` Este endpoint aceita `homolog: true` no corpo: a resposta volta com dados válidos, `api_limit_for` igual a `homolog` e sem tarifação. **Resposta de exemplo, do catálogo** ```json { "user": { "first_name": "[omitido]", "email": "[omitido]", "cellphone": "[omitido]", "notification": "yes" }, "balance": "399,400", "balance_before": "400,000", "tax": "0,600", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 0,60.", "valor_consulta": 0.6, "api_limit_for": "credit", "homolog": false, "data": { "tipo": "voz-tempo-real-1000", "audio_url": "https://gateway.apibrasil.io/proxy/?u=https%3A%2F%2Fvoz-tempo-real.apidocumentos.com.br%2Faudio%2F0f1e2d3c-4b5a-4978-8796-a5b4c3d2e1f0", "tipo_mime": "audio/mpeg", "tamanho_bytes": 52480, "duracao_segundos": 3.28, "expira_em": "2026-11-13T15:00:00Z", "caracteres": 54, "voz": "AbCdEfGhIj0123456789", "formato": "mp3", "modelo": "v4" } } ``` ### 5. POST /consulta/voz-tempo-real/credits ⚠️ Aviso: a chamada é cobrada quando o áudio é gerado e o link é devolvido (HTTP 200). Texto acima de 2500 caracteres, voz que não existe ou não é da sua conta, texto barrado pela moderação e falha na geração não são cobrados. Gerar fala de até 2500 caracteres: Gera o áudio do texto com a voz escolhida e devolve o link para download (audio_url), o tipo do arquivo (tipo_mime), o tamanho em bytes, a duração em segundos, a validade do link (expira_em), quantos caracteres contaram na faixa (caracteres, já com a emoção e as marcações), a voz, o formato e o modelo de voz usado. Este tipo aceita texto de até 2500 caracteres. Envie um POST com tipo=voz-tempo-real-2500 e: - texto (obrigatório, texto): O que vai ser falado: de 1 a 2500 caracteres neste tipo, contando a marcação da emoção e as marcações entre colchetes que você escrever no texto (por exemplo [laughs] ou [whispers]). - voz (obrigatório, texto): O id da voz, tirado da lista do tipo voz-tempo-real-vozes (catálogo ou voz própria da sua conta). - emocao (opcional, texto): alegre, animado, calmo, triste, serio, empatico, profissional, tranquilizador, curioso, surpreso, irritado, sarcastico, sussurrando ou rindo. Vira uma marcação no início do texto e conta no tamanho. - estabilidade (opcional, decimal): De 0 a 1, padrão 0.5. Mais alto deixa a fala mais constante; mais baixo, mais expressiva. - similaridade (opcional, decimal): De 0 a 1, padrão 0.75: o quanto a fala se mantém fiel ao timbre da voz escolhida. - formato (opcional, texto): mp3 (padrão, 44,1 kHz e 128 kbps), mp3_leve (22,05 kHz e 32 kbps), ogg (Opus, o formato da nota de voz do WhatsApp), wav (24 kHz) ou telefonia (µ-law a 8 kHz, para URA). - semente (opcional, inteiro): De 0 a 4294967295. Repetir a semente com o mesmo texto e os mesmos ajustes tende a gerar o mesmo áudio. - variacao (opcional, inteiro): De 0 a 999999, não muda o áudio por si: trocar o número faz o pedido deixar de ser idêntico a um anterior e gera outra versão, em vez de devolver a resposta guardada. Respostas de erro (nenhuma é cobrada): - HTTP 400: texto vazio ou acima de 2500 caracteres (a mensagem diz o tamanho e qual tipo comporta), voz ausente, ou emoção, formato, estabilidade, similaridade ou semente fora da lista ou da faixa - HTTP 404: a voz não existe no catálogo e não é uma voz da sua conta - HTTP 409: um pedido idêntico ainda está em andamento; repita em instantes - HTTP 422: o texto foi barrado pela moderação do serviço de voz - HTTP 502: o serviço de voz respondeu sem o áudio ou com erro - HTTP 503: o serviço de voz está indisponível ou no limite de chamadas simultâneas; tente de novo em alguns segundos - HTTP 504: a geração passou do tempo limite Preço: R$ 1,50 por chamada. Em homologação (homolog=true), sem cobrança, a resposta traz dados fictícios no mesmo formato. O áudio é gerado por inteligência artificial e leva uma marca d'água inaudível, que não pode ser removida. Avise quem ouve que a voz é sintética quando a lei exigir ou quando a falta do aviso puder enganar. O texto é processado em servidores nos Estados Unidos. Não envie no texto dado de saúde, número de cartão ou número de documento oficial, como o CPF. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/voz-tempo-real/credits` - **Versão da rota:** v2 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "voz-tempo-real-2500", "texto": "Olá! Seu pedido foi confirmado e chega amanhã.", "voz": "AbCdEfGhIj0123456789", "emocao": "alegre", "formato": "mp3", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/voz-tempo-real/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"voz-tempo-real-2500","texto":"Olá! Seu pedido foi confirmado e chega amanhã.","voz":"AbCdEfGhIj0123456789","emocao":"alegre","formato":"mp3","homolog":true}' ``` Este endpoint aceita `homolog: true` no corpo: a resposta volta com dados válidos, `api_limit_for` igual a `homolog` e sem tarifação. **Resposta de exemplo, do catálogo** ```json { "user": { "first_name": "[omitido]", "email": "[omitido]", "cellphone": "[omitido]", "notification": "yes" }, "balance": "398,500", "balance_before": "400,000", "tax": "1,500", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 1,50.", "valor_consulta": 1.5, "api_limit_for": "credit", "homolog": false, "data": { "tipo": "voz-tempo-real-2500", "audio_url": "https://gateway.apibrasil.io/proxy/?u=https%3A%2F%2Fvoz-tempo-real.apidocumentos.com.br%2Faudio%2F0f1e2d3c-4b5a-4978-8796-a5b4c3d2e1f0", "tipo_mime": "audio/mpeg", "tamanho_bytes": 52480, "duracao_segundos": 3.28, "expira_em": "2026-11-13T15:00:00Z", "caracteres": 54, "voz": "AbCdEfGhIj0123456789", "formato": "mp3", "modelo": "v4" } } ``` Nos exemplos de resposta, os campos da conta que gerou o exemplo (`user.first_name`, `user.email`, `user.cellphone`) saem como `[omitido]`. O resto é o que o catálogo publica. ## Armadilhas: o que uma integração erra sem avisar Apuradas nas respostas que o próprio catálogo publica. Em todas elas o código funciona no caminho feliz e falha em silêncio no resto: 1. **O erro chega no CORPO, com HTTP 200.** A resposta traz um campo `error` booleano e uma `message`. Checar só `response.ok` ou o status HTTP deixa passar falha como sucesso. Confira SEMPRE `error === false` antes de ler `data`. 2. **`balance`, `tax` e `extra_charges.total` são STRING em formato brasileiro — e o formato varia entre APIs.** Valores observados no catálogo: `"154,380"`, `"497,84"`, `"0,000"` e `"0.19"`. Vírgula em umas, ponto em outra; três casas decimais em umas, duas em outra. Em JavaScript, `parseFloat("154,380")` devolve `154` e perde os centavos sem erro nenhum, e `Number("154,380")` devolve `NaN`. Escreva um conversor que trate os dois separadores, e nunca use esses campos numa decisão financeira sem convertê-los. 3. **Cada chamada custa dinheiro.** Retry cego multiplica a conta. Nunca repita automaticamente um 4xx: parâmetro errado repetido continua errado e continua cobrando. Repita só tempo esgotado e 5xx, com recuo exponencial e um teto pequeno de tentativas. 4. **HTTP 402 é saldo insuficiente, e repetir não resolve.** É o único status que exige ação humana — recarregar. Trate-o como erro terminal, com mensagem própria, e não o jogue no mesmo balde dos 4xx genéricos. 5. **`extra_charges` cobra à parte do preço da consulta.** Quando o corpo pede serviços adicionais, a resposta traz cada um com o preço e um `total` que NÃO está incluso no valor base. Se você mostra custo a quem usa, some os dois. ## Ver também - Especificação OpenAPI: https://doc.apibrasil.io/apis/creditos/360cdbc3-dec0-11f1-98bb-bc24118aba26/openapi.json - Catálogo de APIs: [Catálogo de APIs](https://doc.apibrasil.io/apis.md) - SDKs oficiais: [SDKs oficiais](https://doc.apibrasil.io/sdks.md) - Índice da documentação: https://doc.apibrasil.io/llms.txt - Versão HTML desta página: https://doc.apibrasil.io/apis/creditos/360cdbc3-dec0-11f1-98bb-bc24118aba26