Documentação

Documentação da API

Tudo o que precisa para integrar a moderação de conteúdo da Discuse na sua aplicação. API REST simples, funcionalidades completas e precisão de referência no setor.

Começar

Guia de início rápido para integrar a Discuse API na sua aplicação.

AutenticaçãoChaves de APIInício rápidoSDKs

Análise de texto

Analise conteúdo de texto para detetar spam, toxicidade, sentimento e idioma.

Análise de sentimentoDetecção de spamDetecção de idiomaFiltro de linguagem imprópria

Análise de imagens

Detete conteúdo NSFW e imagens inadequadas com elevada precisão.

Deteção de NSFWClassificação de conteúdoURLs de imagensProcessamento em lote

Processamento de documentos

Extraia texto de imagens e PDFs com OCR e, em seguida, modere-o ou resuma-o.

OCRExtração de textoModeraçãoResumo

Endpoints da API

Visão geral rápida dos endpoints da API disponíveis. Todos os endpoints aceitam JSON e devolvem respostas em JSON.

POST/api/v2/check

Verificação completa de moderação de conteúdo com todas as funcionalidades ativadas.

POST/api/v2/demo/check

Endpoint de demonstração público (com limite de taxa, sem chave de API necessária).

POST/api/v2/scan

Analise ficheiros para detetar malware e vírus.

POST/api/v2/ocr

Extraia texto de imagens e PDFs, com moderação opcional.

POST/api/v2/summarize

Gere um resumo conciso de um documento.

POST/api/v2/demo/ocr

Demonstração pública de OCR (com limite de taxa, sem chave de API; PDFs até 20 páginas).

POST/api/v2/demo/summarize

Demonstração pública de resumo (com limite de taxa, sem chave de API; PDFs até 20 páginas).

Método	Endpoint	Descrição
POST	`/api/v2/check`	Verificação completa de moderação de conteúdo com todas as funcionalidades ativadas.
POST	`/api/v2/demo/check`	Endpoint de demonstração público (com limite de taxa, sem chave de API necessária).
POST	`/api/v2/scan`	Analise ficheiros para detetar malware e vírus.
POST	`/api/v2/ocr`	Extraia texto de imagens e PDFs, com moderação opcional.
POST	`/api/v2/summarize`	Gere um resumo conciso de um documento.
POST	`/api/v2/demo/ocr`	Demonstração pública de OCR (com limite de taxa, sem chave de API; PDFs até 20 páginas).
POST	`/api/v2/demo/summarize`	Demonstração pública de resumo (com limite de taxa, sem chave de API; PDFs até 20 páginas).

URL base

Todos os pedidos à API devem ser feitos para a seguinte URL base:

https://api.discuse.com

Autenticação

Autentique os seus pedidos à API incluindo a sua chave de API no cabeçalho do pedido.

X-API-Key: your_api_key_here

Não tem uma chave de API? Comece por aqui para criar uma.

Formato da resposta

Todas as respostas da API seguem uma estrutura JSON consistente:

{
  "has_violations": false,
  "cached": false,
  "message": "Content appears safe",
  "results": {
    "hits": false,
    "sentiment": {
      "hit": false,
      "toxic": 0.02,
      "profanity": 0.01,
      "threat": 0.00,
      "insult": 0.03
    },
    "spam_finder": {
      "is_spam": false,
      "confidence": 0.05
    },
    "language": {
      "detected": "en",
      "confidence": 0.98
    }
  },
  "processing_time_ms": 45,
  "usage": {
    "api_requests_used": 150,
    "api_requests_limit": 10000,
    "api_requests_remaining": 9850
  }
}

Pronto para começar?

Siga nosso guia de primeiros passos e integre a moderação de conteúdo em minutos.

Iniciar integração