Hyper3D API Documentation
DashboardLoginStart For Free
English
English
  • Introduction
  • GET STARTED
    • Get started with Rodin
    • Minimal Example
  • API Specification
    • Overview
    • Rodin Generation
    • Check Balance
    • Check Status
    • Download Results
    • Generate Texture
  • Legal
    • Data Retention Policy
      • Privacy Policy
      • Terms of Service
      • Contact Us
Powered by GitBook
On this page

Was this helpful?

  1. API Specification

Check Balance

Check the remaining credits in your account.

PreviousRodin GenerationNextCheck Status

Last updated 6 months ago

Was this helpful?

Call this API endpoint to Check the remaining credits in your account.

Pricing

We do not charge any addtional credits for calling this API to check your balance.

Request

Authentication

Authorization: Bearer RODIN_API_KEY

Response

The JSON response has the following fields.

Property
Type
Description

balance

int

Balance of account.

Examples

export RODIN_API_KEY="your api key"
curl --location 'https://hyperhuman.deemos.com/api/v2/check_balance' \
--header 'Authorization: Bearer JWT'
unset RODIN_API_KEY
import requests

# Constants
ENDPOINT = "https://hyperhuman.deemos.com/api/v2/check_balance"
API_KEY = "your api key"  # Replace with your actual API key

# Prepare the headers
headers = {
    'Authorization': f'Bearer {API_KEY}',
}

# Make the GET request
response = requests.get(ENDPOINT, headers=headers)

# Parse and return the JSON response
print(response.json())

This API uses bearer key for authentication. You need to include a valid token in the Authorization header for all requests. Refer to the for how to generate an API key for your account.

Quickstart section

Check the remaining credits in your account.

get
Authorizations
Responses
201Success
application/json
get
GET /api/v2/check_balance HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
201Success
{
  "balance": 1
}
  • GETCheck the remaining credits in your account.
  • Pricing
  • Request
  • Response
  • Examples