ArgorantDocs

Authentication

API keys, the base URL, what each key scope allows, and how AI agents sign in without a key.

Base URL

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

API keys

Sign in at app.argorant.com/profile and create a key under API keys. Keys start with ag_live_ and are shown once. Give each key the name of the thing that uses it, such as zapier, ci or laptop, so you can revoke one without breaking the others.

Send the key with every call:

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

The answer tells you who the key acts as, your plan, your credits, how many requests a minute the key may send and what is left of today's limits. Call it before a large job.

API keys work during the 14-day trial, on every plan and with pay-as-you-go credits. The command line tool reads the same key from npx argorant login or from the ARGORANT_API_KEY variable.

Scopes

A key created in the app holds every scope below. A narrower key gets 403 with the code scope_missing when it calls something outside its scopes.

ScopeAllowsCan cost
argorant:read_countsCounts, word lists, account, reading campaigns, the inbox, mailboxes and webhooksNothing
argorant:search_segmentsMasked previews of people and companiesNothing
argorant:manage_listsLists, campaigns, launching, answering replies, statuses, mailboxes, the blocklist, webhooks, mailbox ordersMailbox orders cost money, after a yes
argorant:unlock_contactsReveals, phone numbers, person enrichment, the email finderCredits
argorant:create_exportsExports and list exportsCredits
argorant:verify_emailsChecking your own listsCredits, half a credit per fresh check

AI agents sign in, they never see the key

MCP clients such as Claude and ChatGPT connect to https://mcp.argorant.com/mcp and sign in with OAuth 2.1 (authorization code with PKCE). They act for your account with the scopes you approve, and your API key never goes into a chat. See Connect a client.

Permissions inside a workspace

A key acts as the person who created it. Owners and members see only their own workspace. Some actions, such as ordering mailboxes, are for the workspace owner; a member gets 403 with a plain message saying so. Items of other workspaces always answer 404 not_found, the same as items that do not exist.

On this page