ArgorantDocs

Autenticação

Chaves de API, a URL base, o que cada escopo de chave permite e como os agentes de IA entram sem chave.

URL base

Text
https://app.argorant.com/api/v1

Chaves de API

Entre em app.argorant.com/profile e crie uma chave em Chaves de API. As chaves começam com ag_live_ e são exibidas uma única vez. Dê a cada chave o nome do que a usa, como zapier, ci ou laptop, para que você possa revogar uma sem quebrar as outras.

Envie a chave em toda chamada:

Shell
curl "https://app.argorant.com/api/v1/account" \
  -H "Authorization: Bearer $ARGORANT_API_KEY"

A resposta informa em nome de quem a chave age, o seu plano, os seus créditos, quantas requisições por minuto a chave pode enviar e o que resta dos limites de hoje. Chame antes de um trabalho grande.

As chaves de API funcionam durante o teste grátis de 7 dias e em todos os planos. A ferramenta de linha de comando lê a mesma chave de npx argorant login ou da variável ARGORANT_API_KEY.

Escopos

Uma chave criada no app tem todos os escopos abaixo. Uma chave mais restrita recebe 403 com o código scope_missing quando chama algo fora dos seus escopos.

EscopoPermitePode custar
argorant:read_countsContagens, listas de termos, conta, leitura de campanhas, a caixa de entrada, caixas de e-mail e webhooksNada
argorant:search_segmentsPrévias mascaradas de pessoas e empresasNada
argorant:manage_listsListas, campanhas, início de campanhas, resposta a respostas, status, caixas de e-mail, a lista de bloqueio, webhooks, pedidos de caixas de e-mailPedidos de caixas de e-mail custam dinheiro, depois de um sim
argorant:unlock_contactsLiberações, números de telefone, enriquecimento de pessoas, o localizador de e-mailsCréditos
argorant:create_exportsExportações e exportações de listasCréditos
argorant:verify_emailsVerificação das suas próprias listasCréditos, meio crédito por verificação nova

Agentes de IA fazem login, nunca veem a chave

Clientes MCP como Claude e ChatGPT se conectam a https://mcp.argorant.com/mcp e fazem login com OAuth 2.1 (authorization code com PKCE). Eles agem pela sua conta com os escopos que você aprova, e a sua chave de API nunca vai para um chat. Veja Conecte um cliente.

Permissões dentro de um workspace

Uma chave age como a pessoa que a criou. Proprietários e membros veem apenas o próprio workspace. Algumas ações, como pedir caixas de e-mail, são do proprietário do workspace; um membro recebe 403 com uma mensagem clara dizendo isso. Itens de outros workspaces sempre respondem 404 not_found, igual a itens que não existem.

Nesta página