Integration Guide

​

The Nevermined Payment Libraries

1. Human to Agent: The libraries can be used in browser or CLI environments, allowing human users to interact with AI Agents. They support registering and listing AI Agents, purchasing access, and querying agents as subscribers.
2. Agent to Agent: The libraries can be embedded within AI Agents, enabling them to interact with other AI Agents, purchase access to APIs, and query them programmatically.

​

Main Features

• Register AI Agents
• Create Pricing Plans defining the conditions (price & usage) for subscribers
• Associate Pricing Plans to AI Agents, so when a subscriber purchases a payment plan they can query all the agents associated to it
• Order Pricing Plans (payments in Fiat & Crypto) giving access to the AI Agents
• Query AI Agents programmatically
• Build AI Agents able to process tasks sent by users
• Easy integration with Agent orchestration frameworks like Google A2A and MCP

​

Prerequisites

​

Installation

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

pip install payments-py

​

Getting Your API Key

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

​

Initialize the SDK

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

​

Basic Configuration Example

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

# 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

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()

​

Common Issues

​

Need Help?

​

Next Steps