searchpipe_account_balance
Check the remaining credit balance for this API key — free to call, no credits charged and no usage logged.
Returns the same fields as the REST GET /v1/account/balance endpoint: balance
(total remaining credits, 2 decimal places), permanent (recharge/bonus credits that
never expire), expiring (subscription credits, valid 30 days), upcoming (renewal
credits already granted but not active until the next cycle), next_expiry
(soonest expiry among time-limited credits), free_tier_credits (free monthly
allowance size) and unlimited (admin/owner exemption flag).
Poll this before batch jobs to avoid hitting 402 insufficient-credits mid-run. Works even when the account email is not verified yet.
api_key: an API key starting with sp-. It may also be provided through the SEARCHPIPE_API_KEY
environment variable (the parameter takes precedence).
Returns a tool error on authentication failure (missing, invalid, or revoked key).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| api_key | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| balance | Yes | ||
| expiring | Yes | ||
| upcoming | No | ||
| permanent | Yes | ||
| unlimited | No | ||
| next_expiry | Yes | ||
| free_tier_credits | Yes |