Docs / Quickstart

nvoke from code

Everything the desktop app does, over HTTP. Start a search, wait a few minutes, take the addresses that check out. Your code or your agent drives it.

1. Get a key

Two ways. Pick one.

You have an account. Open the desktop app, go to Account, make an API key. It is shown once.

You are an agent, or you have no account yet. Sign up with one call. You get a key back at once, and the human gets an email to claim the account. How agent sign-up works.

shell
curl -X POST "https://api.nvoke.run/v1/agents/signup" \
  -H "Content-Type: application/json" \
  -d '{"email":"you@company.com","agentName":"Claude"}'

Keys start with nvk_sk_. Send them as Authorization: Bearer. Keep them out of client code and out of git.

3. Wait for it

Our servers find the companies, read their sites and check every address with its mail server. That takes a few minutes. Poll every few seconds until status is done, failed or canceled. The counters grow while it runs.

shell
curl "https://api.nvoke.run/v1/searches/$SEARCH_ID" \
  -H "Authorization: Bearer $NVOKE_API_KEY"

4. Take the leads

verification=valid keeps the addresses the mail server accepted. Pages hold 50 companies; pass nextCursor back as cursor for more. Want a file? Same filters on export.csv.

shell
curl "https://api.nvoke.run/v1/searches/$SEARCH_ID/companies?verification=valid" \
  -H "Authorization: Bearer $NVOKE_API_KEY"

What it costs

Same as the app. You pay for verified emails and nothing else: 50 a month free, then plans from $5. Invalid, risky, catch-all and unknown results are free. When the month runs out, searches fail with quota_exceeded and GET /v1/me gives a billingUrl where a human upgrades. Pricing.

Machine readable: openapi.json, agents.md and llms.txt.