Skip to content

API Reference

The @nosana/kit SDK exposes the Nosana API as typed route groups under client.api. Each group bundles the endpoints for one area of the platform, and every group is wired into the client automatically:

ts
import { 
createNosanaClient
,
NosanaNetwork
} from '@nosana/kit';
const
client
=
createNosanaClient
(
NosanaNetwork
.
MAINNET
, {
api
: {
apiKey
:
process
.
env
.
NOSANA_API_KEY
},
}); const
balance
= await
client
.
api
.
credits
.
balance
();
const
markets
= await
client
.
api
.
markets
.
list
();

Route Groups

GroupDescription
auth / userSession & API-key validation, API-key management
deploymentsFull deployment lifecycle — see Create, Manage, and Vaults
jobsPost, extend, stop, and query jobs (single & batch)
marketsGPU markets, pricing, Docker images, remote resources
creditsCredit balance, claiming, spending history
templatesDeployment templates catalog
hostsNodes & GPU hosts — discovery, metrics, rewards, node-operator routes
statsNetwork statistics, NOS price, earning/spending history
paymentsPayment methods and credit purchases (Stripe)
benchmarksBenchmark data, thresholds, and node benchmark submission
Raw clientsTyped openapi-fetch clients for every other endpoint

Every reference page lists the SDK method next to the HTTP method and path it calls, so the same pages work as an HTTP API reference. For the raw endpoint-to-method mapping of all services in one file, see packages/api/API_ENDPOINTS.md.

Backend services

The SDK talks to four Nosana services directly. Each route group is served by one (or two) of them:

ServiceServesBase URL (mainnet)
Client Managerauth, user, credits, payments, templates, job writeshttps://client-manager.k8s.prd.nosana.com
Blockchain Indexerjobs (reads), statshttps://blockchain-indexer.k8s.prd.nos.ci
Deployment Managerdeploymentshttps://deployment-manager.k8s.prd.nos.ci
Host Managermarkets, hosts, benchmarkshttps://host-manager.k8s.prd.nosana.com

You never need these URLs when using the SDK — they are resolved from the network configuration. They matter when calling the HTTP API directly.