Skip to main content
The Bitscale API lets you use Bitscale from your own code:
The API is available on every paid plan. On the Free plan every endpoint returns 403 FEATURE_DISABLED.

​
Get your API key

  1. Log in to Bitscale.
  2. Go to Settings → Account → API Key.
  3. Copy the key.
The key belongs to the workspace, not to you: every call runs in that workspace and uses its credits. Keep it secret and never put it in client-side code or a public repository. If it leaks, rotate it from the same settings page or with POST /api-key/rotate; the old key stops working at once.

​
Authentication

Send the key in the X-API-KEY header on every request. No other header identifies the workspace.

​
Rate limits

Each workspace can make 5 requests per second, across all endpoints, polling included. Going over returns 429 RATE_LIMIT_EXCEEDED. To change the limit, contact team@bitscale.ai. Every response carries these headers:

​
Errors

Every error has the same shape: a machine-readable code and a readable message.
Each section lists its own codes: Tools, Sources, Grid APIs.

​
Long-running requests

Tool runs and source searches wait up to 25 seconds for a result. If the work takes longer you get 202 Accepted with a poll_url; call it every 2–5 seconds until the status is no longer running. Set your client timeout to at least 60 seconds.

​
Credits

Calls are billed to the workspace’s credits the same way as in the app. Listing tools and sources, reading schemas, counting and filter-value lookups are free. When the workspace runs out, calls return 402.