Pular para o conteúdo principal
GET
/
api
/
v1
/
voice-templates
# Requisição 1: Obter todos os modelos de voz
curl -X GET "https://app.talkover.ai/api/v1/voice-templates" \
  -H "Authorization: Bearer talq_your_environment_token_here"
{
  "success": true,
  "data": [
    {
      "display_name": "Bianca",
      "voices": [
        {
          "id": "voice-template-uuid-1",
          "name": "Bianca",
          "gender": "female",
          "language": "pt-BR",
          "quality_tier": "basic",
          "cost": "0.10"
        },
        {
          "id": "voice-template-uuid-2",
          "name": "Bianca",
          "gender": "female",
          "language": "pt-BR",
          "quality_tier": "pro",
          "cost": "0.16"
        },
        {
          "id": "voice-template-uuid-3",
          "name": "Bianca",
          "gender": "female",
          "language": "pt-BR",
          "quality_tier": "ultra",
          "cost": "0.23"
        }
      ]
    },
    {
      "display_name": "Isabela",
      "voices": [
        {
          "id": "voice-template-uuid-4",
          "name": "Isabela",
          "gender": "female",
          "language": "pt-BR",
          "quality_tier": "basic",
          "cost": "0.10"
        },
        {
          "id": "voice-template-uuid-5",
          "name": "Isabela",
          "gender": "female",
          "language": "pt-BR",
          "quality_tier": "pro",
          "cost": "0.16"
        }
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.talkover.ai/llms.txt

Use this file to discover all available pages before exploring further.

Listar Modelos de Voz

Recuperar uma lista de modelos de voz disponíveis agrupados por nome de exibição, com opções de filtragem por idioma, qualidade e gênero.

Endpoint

GET /api/v1/voice-templates

Cabeçalhos da Requisição

Authorization
string
obrigatório
Token Bearer para autenticação. Formato: Bearer talq_your_environment_token_here

Parâmetros de Consulta

language
string
Filtrar por idioma (ex: en-US, pt-BR)
quality_tier
string
Filtrar por nível de qualidade. Opções: basic, pro, ultra, beta
gender
string
Filtrar por gênero. Opções: male, female

Exemplos de Requisição

# Requisição 1: Obter todos os modelos de voz
curl -X GET "https://app.talkover.ai/api/v1/voice-templates" \
  -H "Authorization: Bearer talq_your_environment_token_here"
# Requisição 2: Filtrar por idioma português
curl -X GET "https://app.talkover.ai/api/v1/voice-templates?language=pt-BR" \
  -H "Authorization: Bearer talq_your_environment_token_here"
# Requisição 3: Filtrar por qualidade profissional e gênero feminino
curl -X GET "https://app.talkover.ai/api/v1/voice-templates?quality_tier=pro&gender=female" \
  -H "Authorization: Bearer talq_your_environment_token_here"

Resposta

Resposta de Sucesso (200 OK)

{
  "success": true,
  "data": [
    {
      "display_name": "Bianca",
      "voices": [
        {
          "id": "voice-template-uuid-1",
          "name": "Bianca",
          "gender": "female",
          "language": "pt-BR",
          "quality_tier": "basic",
          "cost": "0.10"
        },
        {
          "id": "voice-template-uuid-2",
          "name": "Bianca",
          "gender": "female",
          "language": "pt-BR",
          "quality_tier": "pro",
          "cost": "0.16"
        },
        {
          "id": "voice-template-uuid-3",
          "name": "Bianca",
          "gender": "female",
          "language": "pt-BR",
          "quality_tier": "ultra",
          "cost": "0.23"
        }
      ]
    },
    {
      "display_name": "Isabela",
      "voices": [
        {
          "id": "voice-template-uuid-4",
          "name": "Isabela",
          "gender": "female",
          "language": "pt-BR",
          "quality_tier": "basic",
          "cost": "0.10"
        },
        {
          "id": "voice-template-uuid-5",
          "name": "Isabela",
          "gender": "female",
          "language": "pt-BR",
          "quality_tier": "pro",
          "cost": "0.16"
        }
      ]
    }
  ]
}

Campos da Resposta

success
boolean
obrigatório
Indica se a operação foi bem-sucedida.
data
array
obrigatório
Array de grupos de modelos de voz.

Respostas de Erro

401 Não Autorizado

{
  "success": false,
  "message": "Unauthorized"
}

422 Erro de Validação

{
  "success": false,
  "message": "The given data was invalid.",
  "errors": {
    "language": [
      "The selected language is invalid."
    ],
    "quality_tier": [
      "The selected quality tier is invalid."
    ],
    "gender": [
      "The selected gender is invalid."
    ]
  }
}

500 Erro do Servidor

{
  "success": false,
  "message": "Internal server error."
}

Códigos de Erro

CódigoDescriçãoStatus HTTP
INVALID_TOKENToken de autenticação inválido ou ausente401
VALIDATION_ERRORValidação dos parâmetros de consulta falhou422
SERVER_ERRORErro interno do servidor ocorreu500

Notas Importantes

Agrupamento por nome. Os modelos de voz são agrupados por nome de exibição para facilitar a seleção.
Filtros disponíveis. Use os parâmetros de consulta para filtrar por idioma, qualidade e gênero.
Custos variáveis. Cada nível de qualidade tem um custo diferente por minuto.

Melhores Práticas

  1. Filtre por idioma - Use o parâmetro language para obter vozes no idioma desejado
  2. Considere a qualidade - Escolha o nível de qualidade adequado para seu caso de uso
  3. Teste as vozes - Use o endpoint de demonstração para testar as vozes antes de usar
  4. Monitore custos - Diferentes níveis de qualidade têm custos diferentes
  5. Trate erros - Implemente tratamento adequado de erros para falhas de autenticação e validação

Endpoints Relacionados

  • Gerar Demonstração de Voz: GET /api/v1/voice-templates/{voice_template_id}/demo
  • Listar Números de Telefone: GET /api/v1/phone-numbers