Referência da APIPOST

Analisar descrição do site

Gera uma descrição de IA a partir de uma URL antes de criar ou atualizar um site.

POSThttps://ai.redreplier.com/ai-app/api/v1/websites/analyze-description

Gera uma descrição de IA a partir de uma URL antes de criar ou atualizar um site.

Token Bearer (token de API do RedReplier)

Parâmetros

Este endpoint não aceita parâmetros de caminho nem de consulta.

Corpo da requisição

  • url (string, URL, obrigatório): URL do site a ser analisado.

Resposta

Retorna a descrição gerada.

  • description (string): Resumo gerado por IA do site ou produto.

Notas

Use antes de criar ou atualizar quando quiser revisar a descrição gerada por IA.

Erros

  • 400 Bad Request: Entrada, URL, UUID, enum, parâmetro de consulta ou corpo inválido.
  • 401 Unauthorized: Bearer token ausente ou inválido, ou code: "token_issuer_lost_access" quando a pessoa que criou a chave API foi desativada ou saiu do workspace.
  • 403 Forbidden: code: "subscription_required" quando o plano do workspace não inclui acesso à API, code: "workspace_access_denied" quando X-Workspace-Id indica um workspace que esta credencial não pode alcançar, ou code: "permission_denied" quando seu papel no workspace não tem a permissão redreplier.write (Admin e Editor têm).
  • 404 Not Found: O recurso não existe para a conta do token.
  • 429 Too Many Requests: Limite de requisições excedido. Aguarde os segundos indicados em Retry-After.
  • 500 Internal Server Error: Erro inesperado do servidor.
Exemplo de solicitação (curl)
curl --request POST \
  --url https://ai.redreplier.com/ai-app/api/v1/websites/analyze-description \
  --header 'Authorization: Bearer redreplier_test_1234567890' \
  --header 'Content-Type: application/json' \
  --data '{"url": "https://acmecrm.io"}'
201
{
  "description": "Acme CRM helps small agencies manage sales pipelines, client relationships, and follow-up workflows."
}