Developers

API reference

Reference

Authentication

Keep dashboard sessions, proxy credentials and product API keys separate.

Dashboard account

Sign in on crawlhub.ai using your verified account. The developer portal is public and does not require or collect your password.

Public product API keys

Internal generator access

The internal generator validates a short-lived signed-in account access token and checks staff access on the server. Signing in alone does not enable execution. Use the generator’s Copy access token action only when authorized and only for your own local code example.

A missing or expired session returns 401 sign_in_required. An authenticated account without execution access receives 403 access_pending for an execute request.

Proxy authentication

Proxy username/password credentials and IP allowlists are product-specific. A dashboard password is never a proxy password. Follow the credential format supplied with your active proxy provider.

Protect credentials

  • Load credentials from your runtime’s secret configuration or an interactive prompt.
  • Keep access tokens, passwords and cookies out of screenshots, logs and shared examples.
  • Sign out or revoke sessions when a device should no longer have access.

Search documentation

Search guides, products and reference pages.