Documentação

Comece com uma chamada que funciona

Três receitas. Cada uma tem entrada real, chamada, resposta de exemplo e o primeiro erro que você vai encontrar.

Casos de uso

Ver se uma frase é tóxica

Você tem texto de usuário e precisa de um sinal de passa/não passa antes de exibir.

Entrada

{
  "text": "This product is absolutely amazing"
}

Chamada

Checagem de toxicidade · Chamada

curl -X POST https://api.brainiall.com/v1/nlp/toxicity \
  -H "Authorization: Bearer $BRAINIALL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"This product is absolutely amazing"}'

Resposta de exemplo

{
  "label": "not_toxic",
  "score": 0.001
}

Texto vazio é recusado. Envie um campo text não vazio e tente de novo.

Falar uma frase

Você tem palavras e precisa de áudio para tocar ou guardar.

Entrada

{
  "text": "Hello, welcome.",
  "voice": "brainiall-aria"
}

Chamada

Áudio falado · Chamada

curl -X POST https://api.brainiall.com/v1/tts/synthesize \
  -H "Authorization: Bearer $BRAINIALL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"Hello, welcome.","voice":"brainiall-aria"}' \
  --output speech.wav

Resposta de exemplo

{
  "content_type": "audio/wav",
  "note": "Binary audio. Save the body to speech.wav."
}

Texto vazio é recusado. Envie um campo text não vazio. A voz precisa ser um id do catálogo em GET /v1/tts/voices.

Pontuar uma frase falada

Alguém falou uma frase. Você precisa de uma nota contra o texto de referência.

Entrada

{
  "audio": "<base64-wav>",
  "text": "Hello world"
}

Chamada

Pronúncia · Chamada

curl -X POST https://api.brainiall.com/v1/pronunciation/assess/base64 \
  -H "Authorization: Bearer $BRAINIALL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"audio":"<base64-wav>","text":"Hello world"}'

Resposta de exemplo

{
  "overallScore": 86,
  "sentenceScore": 84,
  "decodedTranscript": "Hello world",
  "words": [
    { "word": "Hello", "score": 90 },
    { "word": "world", "score": 82 }
  ]
}

Áudio ausente é recusado. Envie áudio em base64 no campo audio e o texto de referência.

Autenticação

Toda chamada usa o mesmo cabeçalho. Troque o marcador pela sua chave.

Authorization: Bearer YOUR_KEY

URL basehttps://api.brainiall.com

NLP Suite Endpoints

Detect toxic, offensive, or harmful content in text.

Exemplo de código

curl -X POST https://api.brainiall.com/v1/nlp/toxicity \
 -H "Authorization: Bearer $BRAINIALL_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"text":"This product is absolutely amazing"}'

Próximo: rode esta chamada agora

Checagem de toxicidade

Faça sua primeira chamada agora

Veja se uma frase é tóxica. Voltam um rótulo e uma pontuação.

Uma chamada de texto. O engine diz se a frase é tóxica.

Endpoint

POST /v1/nlp/toxicity

Requisição

{
  "text": "This product is absolutely amazing"
}

Preparando sua chave de API…

Exemplo de código

curl -X POST https://api.brainiall.com/v1/nlp/toxicity \
  -H "Authorization: Bearer $BRAINIALL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"This product is absolutely amazing"}'

Coleção pronta para rodar

{
  "name": "Brainiall first call",
  "baseUrl": "https://api.brainiall.com",
  "authorization": "Bearer $BRAINIALL_API_KEY",
  "requests": [
    {
      "id": "pronunciation",
      "method": "POST",
      "path": "/v1/pronunciation/assess/base64",
      "url": "https://api.brainiall.com/v1/pronunciation/assess/base64",
      "body": {
        "audio": "UklGRmQBAABXQVZFZm10IBAAAAABAAEAQB8AAIA+AAACABAAZGF0YUABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA==",
        "text": "Hello world"
      }
    },
    {
      "id": "tts",
      "method": "POST",
      "path": "/v1/tts/synthesize",
      "url": "https://api.brainiall.com/v1/tts/synthesize",
      "body": {
        "text": "Hello, welcome.",
        "voice": "brainiall-aria"
      }
    },
    {
      "id": "nlp",
      "method": "POST",
      "path": "/v1/nlp/toxicity",
      "url": "https://api.brainiall.com/v1/nlp/toxicity",
      "body": {
        "text": "This product is absolutely amazing"
      }
    }
  ]
}

O mesmo pedido, pronto para colar fora deste navegador. Troque o marcador pela sua chave — a chave nunca é exibida aqui.