Skip to main content
GET
/
v1
/
credits
Check credit balance
curl --request GET \
  --url https://api.videobgremover.com/v1/credits \
  --header 'X-Api-Key: <api-key>'
{
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "total_credits": 123,
  "remaining_credits": 123,
  "used_credits": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.videobgremover.com/llms.txt

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

Authorizations

​
X-Api-Key
string
header
required

API key with format vbr_ followed by 32 characters

Response

Credit balance retrieved successfully

​
user_id
string<uuid>

User identifier

​
total_credits
number

Total credits purchased

​
remaining_credits
number

Credits available for use

​
used_credits
number

Credits already consumed