Skip to content

Get Credit Balance

GET
/v1/credits
curl --request GET \
--url https://example.com/v1/credits

Get your current credit balance.

Returns the total available credits that can be used for finetune jobs. Credits are consumed when running finetune jobs based on instance hourly rates.

x-api-key
Any of:
string

Credit balance retrieved successfully

Media type application/json
CreditBalanceResponse

Response containing user’s credit balance.

object
balance
required
Balance

Total available credits

integer
Example generated
{
"balance": 1
}

Invalid or missing API key

Media type application/json
ErrorResponse

Standard error response.

object
detail
required
Detail

Error message describing what went wrong

string
Example generated
{
"detail": "example"
}

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}