Skip to main content
GET
/
v1
/
credits
Get Active Credits Summary
curl --request GET \
  --url https://api.explorium.ai/v1/credits \
  --header 'api_key: <api-key>'
{
  "response_context": {
    "correlation_id": "<string>",
    "request_status": "success",
    "time_took_in_seconds": 123
  },
  "allocated_credits": 123,
  "remaining_credits": 123
}

Documentation Index

Fetch the complete documentation index at: https://developers.explorium.ai/llms.txt

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

Returns the allocated and remaining credits for your account. Use this endpoint to monitor your current credit usage and remaining balance.

​
Endpoint:

GET https://api.explorium.ai/v1/credits

​
Authentication

Include your account API key in the request header:

​
Response

Returns a JSON object containing:
FieldTypeDescription
allocated_creditsIntegerTotal number of credits assigned to the account
remaining_creditsIntegerNumber of credits currently available for use
response_contextObjectMetadata about the API response (correlation ID etc)

​
Example Response

JSON
{  
  "response_context": {  
    "correlation_id": "5618d686ecb849fda660c3023acf3120",  
    "request_status": "success",  
    "time_took_in_seconds": 0.074  
  },  
  "allocated_credits": 1000,  
  "remaining_credits": 964  
}

Authorizations

​
api_key
string
header
required

Response

Successful Response

This is base response model for all responses in partner service.

​
response_context
ResponseContext · object
required
​
allocated_credits
integer
required

Number of allocated credits

​
remaining_credits
integer
required

Number of remaining credits