Skip to main content
GET
/
v1
/
credits
curl https://api.sendpilot.ai/v1/credits \
  -H "X-API-Key: YOUR_API_KEY"
{
  "globalCredits": {
    "balance": 6200,
    "used": 1200,
    "remaining": 5000
  },
  "leadDatabase": {
    "quota": 10000,
    "used": 3500,
    "remaining": 6500
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.sendpilot.ai/llms.txt

Use this file to discover all available pages before exploring further.

Returns your workspace’s current credits balance, usage, and quota information for all features.

Request

X-API-Key
string
required
Your API key

Response

globalCredits
object
Unified credit pool for all operations (Lead Extractor extraction and enrichment)
leadDatabase
object
Lead Database quota information
curl https://api.sendpilot.ai/v1/credits \
  -H "X-API-Key: YOUR_API_KEY"
{
  "globalCredits": {
    "balance": 6200,
    "used": 1200,
    "remaining": 5000
  },
  "leadDatabase": {
    "quota": 10000,
    "used": 3500,
    "remaining": 6500
  }
}
The globalCredits field represents a unified credit pool used for all Lead Extractor operations including extraction and enrichment. This simplifies credit tracking by consolidating all operations into a single balance.

Authorizations

X-API-Key
string
header
required

API key for authentication

Response

Credits balance and quota information

Credits balance and quota information for all features

globalCredits
object
required

Unified credit pool for all operations (Lead Extractor extraction and enrichment)

leadDatabase
object
required

Lead Database quota information