Referência da APIGET

Uso de alterações de palavras-chave

Verifica a cota mensal de edição de palavras-chave da conta, quanto já foi usado e quanto ainda resta.

GEThttps://ai.redreplier.com/ai-app/api/v1/keywords/change-usage

Verifica a cota mensal de edição de palavras-chave da conta, quanto já foi usado e quanto ainda resta.

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

Este endpoint não exige um corpo JSON.

Resposta

Retorna o uso atual de edição de palavras-chave.

  • limit (number): Cota mensal de edição de palavras-chave; -1 significa ilimitado.
  • used (number): Edições de palavras-chave usadas neste mês.
  • remaining (number): Edições restantes neste mês; -1 significa ilimitado.
  • unlimited (boolean): Indica se a cota é ilimitada.

Notas

As edições de palavras-chave são ilimitadas em todos os planos atuais, então a resposta é limit: -1, used: 0, remaining: -1 e unlimited: true. O endpoint continua disponível para clientes que controlam edições. Adicionar, desativar, ativar e excluir palavras-chave nunca contou.

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 GET \
  --url https://ai.redreplier.com/ai-app/api/v1/keywords/change-usage \
  --header 'Authorization: Bearer redreplier_test_1234567890'
200
{
  "limit": -1,
  "used": 0,
  "remaining": -1,
  "unlimited": true
}