Skip to main content
GET
/
api
/
credits
Get Credits
curl --request GET \
  --url https://search.clado.ai/api/credits \
  --header 'Authorization: Bearer <token>'
{
  "credits": 247,
  "last_topup_at": "2024-01-15T10:30:00Z"
}

Documentation Index

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

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

Check the remaining credit balance for your API key. This endpoint returns your current credit count and last top-up timestamp without consuming any credits.

​
Get Credits

curl -X GET "https://search.clado.ai/api/credits" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

The endpoint returns a JSON object with your credit information: 
{
  "credits": 150,
  "last_topup_at": "2024-01-15T10:30:00Z"
}

​
Response Fields

FieldTypeDescription
creditsintegerNumber of credits remaining in your account
last_topup_atstring or nullISO 8601 timestamp of your last credit purchase/top-up

​
Examples

Check Credits: 
curl -X GET "https://search.clado.ai/api/credits" \
  -H "Authorization: Bearer YOUR_API_KEY"
Example Response: 
{
  "credits": 247,
  "last_topup_at": "2024-01-15T10:30:00Z"
}

​
Error Responses

Status CodeDescription
401Unauthorized - API key missing or invalid
404Not Found - Unable to retrieve credit information
500Internal Server Error - Credit service error

​
Notes

  • This endpoint is free - no credits are consumed
  • last_topup_at will be null if no credits have been purchased
  • Use this endpoint to check balance before making credit-consuming API calls

Authorizations

​
Authorization
string
header
required

API key authentication. Keys start with 'lk_'.

Response

Credits information retrieved successfully

​
credits
integer
required

Number of credits remaining in your account

​
last_topup_at
string | null

ISO 8601 timestamp of your last credit purchase/top-up