Getting Started - Nevermined Docs

This guide will help you set up and initialize the Nevermined Payment Libraries to start monetizing your AI services.

Prerequisites

Before you begin, make sure you have:

Development Environment

Node.js 16+ and npm/yarn (for TypeScript)
Python 3.8+ (for Python)
A code editor (VS Code recommended)

Blockchain Wallet (for crypto payments)

MetaMask or compatible wallet
Some test tokens for the testing environment
Note: Not required for fiat-only payment flows

Nevermined API Key

Get your API key from the Nevermined App

Installation

TypeScript/JavaScript
Python

npm install @nevermined-io/payments
# or
yarn add @nevermined-io/payments

pip install payments-py

Getting Your API Key

Go to the Nevermined App
Log in with your wallet
Navigate to the Settings section in the user menu
Click on the API Keys tab
Generate a new key, give it a descriptive name, and copy it
Store this key securely as an environment variable (e.g., NVM_API_KEY)

Never expose your API key in client-side code or commit it to version control. Always use environment variables.

Initialize the SDK

TypeScript
Python

import { Payments } from '@nevermined-io/payments'

const payments = Payments.getInstance({
  nvmApiKey: process.env.NVM_API_KEY,
  environment: 'testing' // or 'production'
})

from payments_py import Payments
import os

payments = Payments(
    api_key=os.environ.get('NVM_API_KEY'),
    environment='testing'  # or 'production'
)

Environment Configuration

Choose the appropriate environment for your use case:

Testing Environment

Network: Base Sepolia testnet
Use case: Development and testing
Tokens: Test tokens (free)
Environment: 'testing'

Production Environment

Network: Base Mainnet
Use case: Live applications
Tokens: Real tokens (paid)
Environment: 'production'

Basic Configuration Example

Here’s a complete example of setting up the Payments client:

TypeScript
Python

import { Payments } from '@nevermined-io/payments'
import dotenv from 'dotenv'

// Load environment variables
dotenv.config()

// Initialize the Payments client
const payments = Payments.getInstance({
  nvmApiKey: process.env.NVM_API_KEY!,
  environment: 'testing', // Start with testing
  // Optional: specify custom RPC endpoints
  // web3ProviderUri: 'https://your-custom-rpc-endpoint.com'
})

// Verify the connection
console.log('Payments client initialized successfully')

from payments_py import Payments
import os
from dotenv import load_dotenv

# Load environment variables
load_dotenv()

# Initialize the Payments client
payments = Payments(
    api_key=os.environ.get('NVM_API_KEY'),
    environment='testing',  # Start with testing
    # Optional: specify custom RPC endpoints
    # web3_provider_uri='https://your-custom-rpc-endpoint.com'
)

print('Payments client initialized successfully')

Environment Variables Setup

Create a .env file in your project root:

# Required
NVM_API_KEY=your_api_key_here

# Optional - for custom configurations
WEB3_PROVIDER_URI=https://your-custom-rpc-endpoint.com
BUILDER_ADDRESS=your_wallet_address_here

Verification

Test your setup with a simple verification:

TypeScript
Python

async function verifySetup() {
  try {
    // Test the connection by checking if the client is properly initialized
    const config = await payments.getConfig()
    console.log('Setup verified! Environment:', config.environment)
    return true
  } catch (error) {
    console.error('Setup verification failed:', error)
    return false
  }
}

verifySetup()

def verify_setup():
    try:
        # Test the connection by checking if the client is properly initialized
        config = payments.get_config()
        print(f'Setup verified! Environment: {config["environment"]}')
        return True
    except Exception as error:
        print(f'Setup verification failed: {error}')
        return False

verify_setup()

Next Steps

Now that you have the Nevermined Payment Libraries set up, you can:

Create Your First Agent

Learn how to create AI agents and payment plans

Explore Use Cases

Discover what you can build with Nevermined

View Code Examples

See complete implementation examples

Best Practices

Learn security and optimization tips

Common Issues

Invalid API Key Error

Make sure your API key is correctly set in your environment variables and has the proper permissions.

Network Connection Issues

Check that you’re using the correct environment (‘testing’ or ‘production’) and that your network connection is stable.

Wallet Connection Problems

Ensure your wallet has some test tokens for the testing environment or real tokens for production.

If you encounter any issues, check our Troubleshooting Guide or reach out to our community on Discord.

​Prerequisites

​Installation

​Getting Your API Key

​Initialize the SDK

​Environment Configuration

​Basic Configuration Example

​Environment Variables Setup

​Verification

​Next Steps

Create Your First Agent

Explore Use Cases

View Code Examples

Best Practices

​Common Issues

Prerequisites

Installation

Getting Your API Key

Initialize the SDK

Environment Configuration

Basic Configuration Example

Environment Variables Setup

Verification

Next Steps

Common Issues