Referência da API

Primeiros passos com a API RedReplier

A API RedReplier permite que ferramentas externas, automações e agentes de IA gerenciem o monitoramento de menções no Reddit, Hacker News, X, Bluesky e Facebook. Use-a para criar sites monitorados, gerenciar palavras-chave, revisar menções pontuadas por IA, prever alterações de cobrança e configurar alertas por e-mail. A API nunca cobra nem altera o plano: mudanças de plano acontecem no app do RedReplier.

URL base: https://ai.redreplier.com/ai-app/api/v1

Envie um token de API do RedReplier como Bearer token em cada requisição. Os tokens começam com redreplier_; o RedReplier resolve a conta a partir do token.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

A conta é deduzida pelo token de API. Não envie IDs de conta ou organização. Cada chamada roda em um workspace: sem o cabeçalho opcional X-Workspace-Id, ela cai no workspace padrão. Um login OAuth, como o conector do Claude ou do ChatGPT, pode alcançar todos os workspaces de que o membro faz parte, em todas as organizações. Chame Listar workspaces e envie o id desejado em X-Workspace-Id. Uma chave API pertence a um workspace, então envie o próprio id dela ou omita o cabeçalho.

X-Workspace-Id: acct_7dK9pQ2

Comece por Listar sites para descobrir IDs de sites e palavras-chave.

Recursos principais:

  • Website: produto, domínio ou marca monitorada.
  • Keyword: frase comparada com publicações e comentários no Reddit, Hacker News, X, Bluesky e Facebook para um site.
  • Mention: publicação ou comentário encontrado no Reddit, Hacker News, X, Bluesky ou Facebook com relevanceScore de 0 a 100.
  • Alert settings: cadência de e-mail para novas menções relevantes.

Status de palavra-chave: PENDING, ACTIVE, DISABLED, SUSPENDED. Status de menção: NEW, APPROVED, REJECTED.

Endpoints REST

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: O cabeçalho X-Workspace-Id indica um workspace que esta credencial não pode alcançar, inclusive o id de outro workspace enviado com uma chave API. O corpo traz code: "workspace_access_denied" e o workspaceId. Um 403 com code: "subscription_required" significa que o plano do workspace não inclui acesso à API. Um 403 com code: "permission_denied" significa que seu papel no workspace não tem a permissão que a chamada exige: o RedReplier exige redreplier.write, que Admin e Editor têm. Esse corpo informa a requiredPermission e o seu role.
  • 404 Not Found: O recurso não existe para a conta do token.
  • 429 Too Many Requests: Limite de requisições excedido. Toda resposta traz RateLimit-Policy, RateLimit-Limit, RateLimit-Remaining e RateLimit-Reset, e um 429 adiciona Retry-After em segundos. Os limites são contados por chave API.
  • 500 Internal Server Error: Erro inesperado do servidor.

Um workspace recusado responde:

{
  "statusCode": 403,
  "error": "Forbidden",
  "code": "workspace_access_denied",
  "workspaceId": "acct_3Hm8XwR",
  "message": "Você não tem acesso ao espaço de trabalho acct_3Hm8XwR. Chame GET /workspaces para listar os espaços de trabalho que pode usar e envie um desses ids no cabeçalho X-Workspace-Id."
}

Voltar para começar