/

/Lium Backend API

Changes Docs Sign in

APIs1

Docs
History
Schema

Filter operations

General APIs with JWT140

get/Health Check
get/versionGet Version
get/readyReadiness probe
post/usersSignup
get/users/get-ipGet Client Ip Endpoint
post/users/loginLogin
put/users/meUpdate User
delete/users/meDelete User
get/users/me/discord/oauth-urlGet Discord Oauth Url
get/users/me/discord/callbackConnect Discord Callback
delete/users/me/discordDisconnect Discord
get/users/me/preferenceGet User Preference
delete/users/me/preference/default-templateClear Default Template
post/users/request-reset-passwordRequest Reset Password
post/users/reset-passwordReset Password
post/users/presigned-urlGenerate Presigned Url
get/users/me/auto-top-upGet Auto Top Up
put/users/me/auto-top-upUpdate Auto Top Up
delete/users/me/auto-top-upTurn Off Auto Top Up
delete/users/me/auto-top-up/first-charge-noticeDismiss Auto Top Up First Charge Notice
get/users/me/notificationGet Notification Setting
put/users/me/notificationUpdate Notification Setting
get/users/me/billing-profileGet Billing Profile
put/users/me/billing-profileUpdate Billing Profile
get/users/me/low-balance-thresholdGet Low Balance Threshold
put/users/me/low-balance-thresholdUpdate Low Balance Threshold
post/users/me/transfer-creditsTransfer Credits
get/users/me/transfer-historyGet Transfer History
get/users/me/transfer-credit-historyGet Transfer Credit History
put/users/me/referral-payout-methodUpdate Referral Payout Method
get/executorsGet all available nodes
get/executors/infiniband-clustersGet nodes that can be combined into an InfiniBand cluster
get/executors/countCount Executors
get/executors/total-countGet Total Count Of Active Executors
get/executors/statsGet stats of nodes
get/executors/default-docker-imageGet default docker image of node
get/executors/deployment-estimateEstimate deployment time
get/executors/wsCurrent snapshot of the rentable executors (WebSocket address)
get/nodesList rentable nodes
post/stripe/create-checkout-sessionCreate Checkout Session
post/stripe/webhookStripe Webhook
get/stripe/payments/payment-methodsList Payment Methods
post/stripe/payments/payment-methodsAdd Payment Method
delete/stripe/payments/payment-methods/{payment_method_id}Delete Payment Method
post/stripe/connect/accountCreate Connect Account
post/stripe/connect/onboarding-linkCreate Onboarding Link
get/stripe/invoices/{invoice_id}Get Invoice
get/stripe/connect/supported-countriesGet Supported Countries
post/auth/signupFingerprint Signup
post/auth/loginFingerprint Login
post/auth/github-loginLogin With Github
post/auth/github-login-completeGithub Login Complete
post/auth/google-loginLogin With Google
post/auth/google-login-completeGoogle Login Complete
post/auth/refreshRefresh Session
post/auth/logoutLogout
post/auth/verify-emailVerify Email
post/auth/resend-verify-emailResend Verify Email
get/locations/country_codesFind Templates
get/machinesList all available machines
get/machines/capacityOpen earning capacity by GPU type
get/machines/capacity/ineligibleGPU types outside the idle-pay program
get/machines/estimateGet GPU reward estimate
get/transactionsGet the user's transactions
post/coinbase/webhookWebhooks
post/coinbase/create-chargeCreate Charge
post/tmc-pay/webhookTmc Pay Webhook
post/tmc-pay/create-invoiceCreate Invoice
get/tmc-pay/currenciesGet Currencies
post/tao/webhookWebhook
get/billing/revenue-for-validatorsRevenue For Validators
get/keysList Api Keys
post/keysCreate Api Key
get/keys/scopesWhat each API-key scope and pod-visibility setting reaches
get/keys/{api_key_id}Get Api Key
put/keys/{api_key_id}Update Api Key
delete/keys/{api_key_id}Delete Api Key
patch/keys/{api_key_id}Set or clear the key's budgets or end-customer tag
get/volumes/costsGet volume cost breakdown
get/volumes/cost-summaryGet aggregated cost summary
get/volumes/{volume_id}/current-statsGet current volume size and file count
get/volumesGet all available volumes
post/volumesCreate a new volume
get/volumes/{volume_id}Get a volume
put/volumes/{volume_id}Update a volume
delete/volumes/{volume_id}Delete a volume
get/machine-requestsList machine requests
post/machine-requestsCreate a machine request
get/machine-requests/{request_id}Get one of the caller's machine requests
put/machine-requests/{request_id}Update a request
delete/machine-requests/{request_id}Close a request
get/machine-requests/{request_id}/executorsGet nodes assigned to one of the caller's machine requests
post/machine-requests/{request_id}/achieveAchieve a request
get/reclaimsGet reclaims with filtering
post/cli-auth/initInit Cli Auth Session
post/cli-auth/approveApprove Cli Auth Session
get/cli-auth/status/{session_id}Cli Auth Session Status
get/cli-auth/poll/{session_id}Poll Cli Auth Session
get/backup-configs/pod/{pod_id}Get backup configuration
get/backup-configsList backup configurations
post/backup-configsCreate backup configuration
put/backup-configs/{config_id}Update backup configuration
delete/backup-configs/{config_id}Delete backup configuration
get/referrals/program-infoGet Referral Program Info
get/referrals/my-codeGet My Referral Code
get/referrals/statsGet Referral Stats
post/referrals/validate/{code}Validate Referral Code
get/referrals/historyGet Referral History
post/referrals/withdrawWithdraw Referral Rewards
get/referrals/pending-payoutsGet Pending Payouts
post/provider-referrals/attributeAttribute Provider Referral
post/provider-referrals/first-loginRecord Provider First Login
get/provider-referrals/summaryProvider Referral Summary
post/provider-referrals/payoutRequest Provider Referral Payout
get/backup-logs/pod/{pod_id}Get backup logs
put/backup-logs/{backup_log_id}/progressUpdate backup progress
get/backup-logs/{backup_log_id}Get backup log
delete/backup-logs/{log_id}Delete backup log
post/backup-logs/{backup_log_id}/cancelCancel backup
get/backup-logs/Get all backup logs
post/backup-logs/bulk-deleteBulk delete backup logs (async)
get/backup-logs/bulk-delete/status/{task_id}Poll bulk delete task status
post/restore-logs/{restore_log_id}/cancelCancel restore
put/restore-logs/{restore_log_id}/progressUpdate restore progress
get/feedbacksGet User Feedbacks
post/feedbacksCreate Feedback
get/feedbacks/{feedback_id}Get Feedback By Id
put/feedbacks/{feedback_id}Update Feedback
delete/feedbacks/{feedback_id}Delete Feedback
get/provider-stats/{miner_hotkey}Get comprehensive statistics for a provider
get/provider-stats/{miner_hotkey}/executorsGet nodes for a provider
get/provider-stats/coldkey/{miner_coldkey}Find the provider pages of a coldkey
get/crypto-walletsList Crypto Wallets
post/crypto-walletsAdd Crypto Wallet
delete/crypto-wallets/{wallet_id}Delete Crypto Wallet
put/crypto-wallets/{wallet_id}/set-defaultSet Default Crypto Wallet
get/payoutsGet User Payouts
get/payouts/{payout_id}Get Payout Details
post/stablecoin/webhookCrypto Transfer Webhook
post/stablecoin/provider-payouts/webhookProvider Payout Webhook

Notifications1

Payments1

Public APIs For Providers4

Public demand feed1

Public nodes feed1

Support API Key Authentication59

Workspaces18

General APIs with JWT

Changes to Request Provider Referral Payout

post/provider-referrals/payout

Sep 15, 2026dceeee0b467c Revision changes
- ○
  endpoint added

Ask about this API