Get started

Authentication

API keys, the Authorization header, and checking your balance.

Every request to /v1/… carries an API key as a bearer token. Keys start with sk_live_ or sk_test_.

header

Authorization: Bearer sk_live_…

Creating and rotating keys

Create keys under API keys in the dashboard. A key is shown once when it is created; we store only a hash, so it cannot be shown again. To rotate, create a new key, deploy it, then revoke the old one. A revoked key stops working immediately.

All keys on an account share one credit balance. Rate limits are per key, so a noisy worker cannot starve the rest of your traffic.

Keep keys on the server. A key in browser JavaScript or a mobile app can be read by anyone who opens it, and they would spend your credits.

Checking a key

GET /v1/me returns the calling key, the account’s balance and the key’s limits. It is free.

shell

curl https://api.crawlfeed.dev/v1/me -H "Authorization: Bearer $CRAWLFEED_KEY"

When authentication fails

A missing, malformed, unknown or revoked key all return 401 unauthorized with the same body, so the response never reveals whether a key exists.