Credits API

The Credits API allows you to check your account's credit balance. Credits are used to pay for deployments when using API key authentication.

Overview

Credits are the currency used in the Nosana Network when using API key authentication. Each deployment execution consumes credits based on the resources used and execution time.

Get Credit Balance

Check your current credit balance:

import { createNosanaClient } from '@nosana/kit';

const client = createNosanaClient({
  api: {
    apiKey: process.env.NOSANA_API_KEY,
  },
});

// Get credit balance
const balance = await client.api.credits.balance();

console.log('Assigned Credits:', balance.assignedCredits);
console.log('Reserved Credits:', balance.reservedCredits);
console.log('Settled Credits:', balance.settledCredits);
console.log('Available Credits:', balance.assignedCredits - balance.reservedCredits - balance.settledCredits);

Balance Fields

Field	Description
assignedCredits	Total credits assigned to your account
reservedCredits	Credits currently reserved for running deployments
settledCredits	Credits that have been consumed by completed deployments
Available Credits	assignedCredits - reservedCredits - settledCredits

Understanding Credit Usage

• Reserved Credits: Credits that are currently allocated to active deployments. These credits are held until the deployment completes or is stopped.
• Settled Credits: Credits that have been consumed by completed deployments. These are permanently deducted from your balance.
• Available Credits: The amount of credits you can use for new deployments. This is calculated as assignedCredits - reservedCredits - settledCredits.

Insufficient Credits

If you don't have enough available credits, deployments will fail with an INSUFFICIENT_FUNDS status. You can:

1. Check your balance using this API
2. Top up your account through the Nosana Deploy dashboard
3. Wait for running deployments to complete and release reserved credits