Get account balance
Returns the authenticated user's current credit balance.
Operation
GET
/v1/balanceHeaders
x-api-keystringrequired(header)
API key (`sfk_...`)
Response fields
data
objectrequired
Endpoint-specific response payload.
databalance
integerrequired
Current credit balance for the authenticated API user.
≥ 0
meta
objectrequired
Metadata describing the request and billing outcome.
metarequestId
stringrequired
Unique request identifier for tracing this API call.
min 1 chars
metacreditsCharged
integerrequired
Credits charged for this request.
≥ 0
metaversion
stringrequired
Public API version that served the response.
one of: v1
Code example
Responses
OK
Error codes
internal_errortemporarily_unavailableunauthorized