Documentation IndexFetch the complete documentation index at: /llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
cURL
curl --request GET \ --url https://api.heygen.com/v3/users/me \ --header 'x-api-key: <api-key>'
{ "data": { "username": "<string>", "email": "user@example.com", "first_name": "Jane", "last_name": "Doe", "billing_type": "wallet", "wallet": { "remaining_balance": 125.5, "auto_reload": { "enabled": true, "threshold_usd": 10, "amount_usd": 50 } }, "subscription": { "credits": { "premium_credits": { "remaining": 500, "resets_at": "2024-05-01T00:00:00Z" }, "add_on_credits": { "remaining": 500, "resets_at": "2024-05-01T00:00:00Z" } } }, "usage_based": { "spending_current_usd": 42.5, "spending_cap_usd": 100 } } }
Returns the authenticated user’s profile, remaining credits or balance, and billing details.
HeyGen API key. Obtain from your HeyGen dashboard.
Successful response
Show child attributes