Skip to main content
Every Stophy call takes an API key. Sign up, create a key, and set it as STOPHY_API_KEY.

Get a key

  1. Sign up at stophy.dev/signup with GitHub or Google. A new account starts with a free balance, shown on Pricing.
  2. Create a key on the API keys page.
  3. Set it in your environment. The SDKs, the CLI and the MCP package read it from there.
Send it on every call as Authorization: Bearer $STOPHY_API_KEY. Every key on an account spends from one balance. Keep keys in a server secret store, never in committed code or browser code.

Other ways to sign in

Sign up from an agent

An agent asks for an account, and you approve it in the browser. Over MCP, the stophy_signup tool runs the same two steps. Both calls are free and take no key.
  1. Start a signup:
    It answers 201:
  2. Give your person the claimUrl. They sign in with GitHub or Google and approve. Keep code secret. Both expire at expiresAt, 24 hours after the signup.
  3. Poll with the code every few seconds:
    Until your person approves, it answers 202 with "status": "waiting". After that it answers 200 with data.apiKey, once. Save the key where your person agreed.

Check a key

GET /v1/limits is free. It returns balanceUsd, rateLimit and keyExpiresAt, which is null for a key that never expires, such as one an agent collected. A wrong, revoked or expired key answers 401 unauthorized, with signupUrl and signup for a new one.

Rotate or revoke a key

To rotate, create the new key, deploy it, then revoke the old one. DELETE /v1/key revokes the key you send it with, at once, for free. stophy logout revokes the CLI’s key. Filter GET /v1/logs by apiKeyId to see one key’s calls.

Calls without a key

Search, scrape, map and parse also answer without a key, within the keyless limits, first page only. A parser works without a key when keyless is true in GET /v1/parsers. Everything else answers 401 apiKeyRequired with signupUrl for a person and signup for an agent, and so does a keyless call that sends one of these: