Quickstart

This guide provides a quick path to integrating Nevermined, whether you’re an AI Builder looking to monetize a service or a Subscriber wanting to access one. You can interact with Nevermined through our user-friendly Web App or programmatically via our SDKs.

For AI Builders: Monetize Your Agent

Using the Nevermined Web App (No Code)

The easiest way to get started is by using the Nevermined App to register your agent and create payment plans through a visual interface.

Log In: Access the app and connect your wallet.
Register Agent: Navigate to the “Agents” section and click “Register New Agent”. Fill in your agent’s metadata, such as name, description, and API endpoints.
Create Payment Plan: Define one or more payment plans for your agent, specifying price, currency (fiat or crypto), and usage terms (subscription or credits).
Done!: Your agent is now discoverable and ready to accept payments.

Using the SDKs (Programmatic)

For developers who need to automate and integrate directly, our SDKs are the perfect tool.

1. Get Your API Key

To interact with the Nevermined API, you need an 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).

2. Install and Initialize the SDK

Install the SDK and initialize the Payments client with your API key.

TypeScript
Python

npm install @nevermined-io/payments

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

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

pip install payments-py

import os
from payments_py import Payments

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

3. Register Your AI Agent

Define your agent’s metadata, API endpoints, and payment plan. Then, register it with a single call.

TypeScript
Python

import { getERC20PriceConfig, getFixedCreditsConfig } from '@nevermined-io/payments';

// Define agent metadata
const agentMetadata = {
  name: 'My AI Assistant',
  tags: ['ai', 'assistant'],
  dateCreated: new Date(),
};

// Define API endpoints
const agentApi = {
  endpoints: [{ POST: 'https://api.myservice.com/query' }],
};

// Define plan metadata
const planMetadata = {
  name: 'Basic Plan',
  description: '100 queries per month',
  dateCreated: new Date(),
};

// Configure pricing (e.g., 10 USDC)
const priceConfig = getERC20PriceConfig(
  10_000_000n, // 10 USDC (6 decimals)
  '0xA0b86a33E6441c41F4F2B8Bf4F2B0f1B0F1C1C1C', // USDC address
  process.env.BUILDER_ADDRESS
);

// Configure credits (e.g., 100 queries)
const creditsConfig = getFixedCreditsConfig(100n, 1n);

// Register agent and plan together
const { agentId, planId } = await payments.agents.registerAgentAndPlan(
  agentMetadata,
  agentApi,
  planMetadata,
  priceConfig,
  creditsConfig
);

console.log(`Agent registered: ${agentId}`);

# Define agent metadata
agent_metadata = {
    'name': 'My AI Assistant',
    'tags': ['ai', 'assistant'],
    'dateCreated': '2023-10-27T10:00:00Z',
}

# Define API endpoints
agent_api = {
    'endpoints': [{'POST': 'https://api.myservice.com/query'}]
}

# Define plan metadata
plan_metadata = {
    'name': 'Basic Plan',
    'description': '100 queries per month',
    'dateCreated': '2023-10-27T10:00:00Z',
}

# Configure pricing (e.g., 10 USDC)
price_config = {
    'priceType': 'FIXED_PRICE',
    'tokenAddress': '0xA0b86a33E6441c41F4F2B8Bf4F2B0f1B0F1C1C1C',
    'amounts': [10000000],
    'receivers': [os.environ.get('BUILDER_ADDRESS')]
}

# Configure credits (e.g., 100 queries)
credits_config = {
    'creditsType': 'FIXED',
    'amount': 100,
    'creditsPerRequest': 1
}

# Register agent and plan together
agent_info = payments.agents.register_agent_and_plan(
    agent_metadata,
    agent_api,
    plan_metadata,
    price_config,
    credits_config
)

print(f"Agent registered: {agent_info['agentId']}")

4. Accept Payments

In your agent’s backend, add logic to validate requests from subscribers. This ensures that only authorized users can access your service.

// Example in an Express.js route
app.post('/api/query', async (req, res) => {
  // Extract authorization header
  const authHeader = req.headers['authorization'];
  
  // For agents using Nevermined Proxy:
  // The proxy handles validation automatically
  // Just ensure your agent is registered with endpoints
  
  // For direct integration:
  if (!authHeader || !authHeader.startsWith('Bearer ')) {
    return res.status(401).json({ error: 'Unauthorized' });
  }
  
  const token = authHeader.substring(7);
  
  // Validate the access token
  const validationResult = await payments.requests.isValidRequest(
    token,
    req.body
  );
  
  if (!validationResult.isValid) {
    // Return 402 Payment Required with payment options
    return res.status(402).json({
      error: 'Payment Required',
      plans: validationResult.plans
    });
  }
  
  // Process the AI request
  const result = await processAIQuery(req.body.prompt);
  
  // Credits are automatically redeemed by the proxy
  // or you can manually redeem for direct integration
  
  res.json(result);
});

This flow protects your agent and automates billing.

For Subscribers: Access an AI Agent

Using the Nevermined Web App

Discover: Find agents in the Nevermined App or other marketplaces.
Purchase: Select a payment plan and purchase it with crypto or a credit card.
Get Credentials: Once purchased, you’ll receive API credentials to access the agent.

Using the SDKs

TypeScript
Python

// 1. Discover the agent and its plans
const agent = await payments.agents.getAgent('AGENT_ID');
const plan = agent.plans[0];

// 2. Purchase the plan
// Option A: Crypto payment
const orderResult = await payments.plans.orderPlan(plan.planId);
console.log('Order transaction:', orderResult.transactionHash);

// Option B: Fiat payment (credit card)
const { sessionId, url } = await payments.plans.orderFiatPlan(plan.planId);
window.location.href = url; // Redirect to Stripe

// 3. Get access credentials
const credentials = await payments.agents.getAgentAccessToken(
  plan.planId,
  agent.agentId
);

// 4. Query the agent using the access token
const response = await fetch(agent.endpoints[0].url, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${credentials.accessToken}`
  },
  body: JSON.stringify({ 
    prompt: "Hello, how can you help me?" 
  })
});

const result = await response.json();
console.log('Agent response:', result);

import requests

# 1. Discover the agent and its plans
agent = payments.agents.get_agent('AGENT_ID')
plan = agent['plans'][0]

# 2. Purchase the plan
# Option A: Crypto payment
order_result = payments.plans.order_plan(plan['planId'])
print(f'Order transaction: {order_result["transactionHash"]}')

# Option B: Fiat payment (credit card)
fiat_result = payments.plans.order_fiat_plan(plan['planId'])
print(f'Stripe checkout URL: {fiat_result["url"]}')

# 3. Get access credentials
credentials = payments.agents.get_agent_access_token(
    plan['planId'],
    agent['agentId']
)

# 4. Query the agent using the access token
response = requests.post(
    agent['endpoints'][0]['url'],
    headers={
        'Content-Type': 'application/json',
        'Authorization': f'Bearer {credentials["accessToken"]}'
    },
    json={'prompt': 'Hello, how can you help me?'}
)

result = response.json()
print(f'Agent response: {result}')

Demos and Examples

Explore our collection of demos and real-world examples to see what’s possible with Nevermined.

Example Apps

See full-stack implementations and integration patterns.

Getting Started

Integration Guide

For AI Builders: Monetize Your Agent

Using the Nevermined Web App (No Code)

Using the SDKs (Programmatic)

For Subscribers: Access an AI Agent

Using the Nevermined Web App

Using the SDKs

Demos and Examples

Example Apps

​For AI Builders: Monetize Your Agent

​Using the Nevermined Web App (No Code)

​Using the SDKs (Programmatic)

​For Subscribers: Access an AI Agent

​Using the Nevermined Web App

​Using the SDKs

​Demos and Examples

Example Apps

For AI Builders: Monetize Your Agent

Using the Nevermined Web App (No Code)

Using the SDKs (Programmatic)

For Subscribers: Access an AI Agent

Using the Nevermined Web App

Using the SDKs

Demos and Examples