Skip to main content

Get API Call Usage and Credit Status

This endpoint returns API usage metrics for the company. It returns total, used, and available credits, along with any credits currently in escrow.

Header Parameters
x-api-key uuid — REQUIRED
x-api-secret uuid — REQUIRED
Responses
Success
Schema — OPTIONAL
success boolean
data object
available_credits number
total_credits number
credits_escrow number
credits_used number
Failed
Schema — OPTIONAL
success string
message string