CreditsApi

valkyrai-api

All URIs are relative to http://localhost:8080/v1

Method	HTTP request	Description
getCreditsAccountBalance	GET CreditsApi	Get current credit balance and transaction history

getCreditsAccountBalance

AccountBalance

getCreditsAccountBalance(accountId)

Get current credit balance and transaction history

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.CreditsApi;


CreditsApi apiInstance = new CreditsApi();
UUID accountId = UUID.randomUUID(); // UUID | Owning customer account id

try {
    AccountBalance result = apiInstance.getCreditsAccountBalance(accountId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CreditsApi#getCreditsAccountBalance");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
accountId	UUID	Owning customer account id

Return type

AccountBalance

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getCreditsAccountBalanceSummary

CreditBalanceSummary

getCreditsAccountBalanceSummary(accountId)

Get current credit balance summary

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.CreditsApi;


CreditsApi apiInstance = new CreditsApi();
UUID accountId = UUID.randomUUID(); // UUID | Owning customer account id

try {
    CreditBalanceSummary result = apiInstance.getCreditsAccountBalanceSummary(accountId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CreditsApi#getCreditsAccountBalanceSummary");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
accountId	UUID	Owning customer account id

Return type

CreditBalanceSummary

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getMyCreditsAccountBalanceSummary

CreditBalanceSummary

getMyCreditsAccountBalanceSummary()

Get current credit balance summary for the authenticated account

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.CreditsApi;


CreditsApi apiInstance = new CreditsApi();

try {
    CreditBalanceSummary result = apiInstance.getMyCreditsAccountBalanceSummary();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CreditsApi#getMyCreditsAccountBalanceSummary");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

CreditBalanceSummary

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

recordCreditsPaymentTransaction

BalanceResponse

recordCreditsPaymentTransaction(accountIdidempotencyKeypaymentTransaction)

Record payment transaction (credit top-up)

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.CreditsApi;


CreditsApi apiInstance = new CreditsApi();
UUID accountId = UUID.randomUUID(); // UUID | Owning customer account id
String idempotencyKey = "idempotencyKey_example"; // String | Request idempotency key for dedupe-safe retries
PaymentTransaction paymentTransaction = new PaymentTransaction(); // PaymentTransaction | 

try {
    BalanceResponse result = apiInstance.recordCreditsPaymentTransaction(accountIdidempotencyKeypaymentTransaction);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CreditsApi#recordCreditsPaymentTransaction");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
accountId	UUID	Owning customer account id
idempotencyKey	String	Request idempotency key for dedupe-safe retries
paymentTransaction	PaymentTransaction

Return type

BalanceResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

recordCreditsUsageTransaction

BalanceResponse

recordCreditsUsageTransaction(accountIdidempotencyKeyusageTransaction)

Record usage transaction (credit debit)

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.CreditsApi;


CreditsApi apiInstance = new CreditsApi();
UUID accountId = UUID.randomUUID(); // UUID | Owning customer account id
String idempotencyKey = "idempotencyKey_example"; // String | Request idempotency key for dedupe-safe retries
UsageTransaction usageTransaction = new UsageTransaction(); // UsageTransaction | 

try {
    BalanceResponse result = apiInstance.recordCreditsUsageTransaction(accountIdidempotencyKeyusageTransaction);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CreditsApi#recordCreditsUsageTransaction");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
accountId	UUID	Owning customer account id
idempotencyKey	String	Request idempotency key for dedupe-safe retries
usageTransaction	UsageTransaction

Return type

BalanceResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Generated Version Details

~	value
GENERATOR VERSION	com.valkyrlabs:ValkyrAI API 1.0.3-SNAPSHOT
API ARTIFACT	com.valkyrlabs.valkyrai-api.jar
GENERATOR VERSION	org.openapitools.openapi-generator:7.5.0
GENERATOR CLASS	org.openapitools.codegen.languages.SpringCodegen
GENERATED DATE	2026-05-16T11:45:23.900207-07:00[America/Los_Angeles]