Nevermined Payments

Integrate Nevermined for AI payments, subscriptions, and access control

Overview

This node integrates with the Nevermined platform to manage AI agent payments, subscriptions, and access control. Specifically, the Register Agent operation allows users to register a new AI agent by providing metadata, API endpoint, supported plan IDs, and additional options such as public accessibility and webhook URL.

Typical use cases include:

  • Registering an AI agent that will be accessible via a specified API endpoint.
  • Associating the agent with one or more subscription or credit plans.
  • Configuring whether the agent is publicly accessible or restricted.
  • Setting up webhook URLs for receiving notifications related to the agent.

For example, a company building multiple AI services can register each service as an agent with its own metadata and API endpoint, linking them to different payment plans for monetization.

Properties

Name Meaning
Agent Metadata JSON object containing metadata about the agent, including name, description, tags (array), and links (array). Example: { "name": "My AI Agent", "description": "Agent description", "tags": ["ai", "nlp"], "links": ["https://example.com"] }
API Endpoint The URL of the API endpoint where the agent is accessible. This is required. Example: https://api.example.com/v1/agent
Plan IDs Comma-separated list of plan IDs that this agent supports. Example: plan-123,plan-456
Additional Options Collection of optional settings:
Public Agent (boolean): Whether the agent should be publicly accessible (default: true)
Webhook URL (string): URL to receive webhook notifications for this agent
Custom Headers (JSON): Custom HTTP headers to include when calling the agent API

Output

The output JSON contains details about the registered agent, including:

  • agentId: A unique identifier generated for the agent.
  • metadata: The parsed metadata JSON provided in input.
  • apiEndpoint: The API endpoint URL.
  • planIds: Array of plan IDs supported by the agent.
  • isPublic: Boolean indicating if the agent is publicly accessible.
  • webhookUrl: The webhook URL if provided.
  • registeredAt: Timestamp of registration.
  • environment: The environment used (e.g., "production" or "test").
  • status: Status string, typically "registered".
  • message: Confirmation message indicating successful registration.

Example output snippet:

{
  "agentId": "agent_1680000000000_abcd123",
  "metadata": {
    "name": "My AI Agent",
    "description": "Agent description",
    "tags": ["ai", "nlp"],
    "links": ["https://example.com"]
  },
  "apiEndpoint": "https://api.example.com/v1/agent",
  "planIds": ["plan-123", "plan-456"],
  "isPublic": true,
  "webhookUrl": "https://example.com/webhook",
  "registeredAt": "2024-06-01T12:00:00.000Z",
  "environment": "test",
  "status": "registered",
  "message": "Agent successfully registered with Nevermined"
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for the Nevermined Payments API.
  • The node uses environment configuration to determine the base URL for API calls (production or test).
  • No external libraries beyond n8n's standard workflow utilities are needed.
  • Proper network connectivity to the Nevermined API endpoints is necessary.

Troubleshooting

  • Invalid JSON in Agent Metadata: If the metadata JSON is malformed, the node throws an error specifying the JSON parsing issue. Ensure the JSON is valid and properly formatted.
  • Missing API Endpoint: The API endpoint URL is mandatory. Omitting it results in an error. Provide a valid URL.
  • API Key Not Provided: The node requires a valid API key credential. Without it, execution fails.
  • Plan IDs Format: Plan IDs must be comma-separated strings. Empty or invalid formats may cause unexpected behavior.
  • General Registration Failure: Errors during registration may indicate issues with the API key, network connectivity, or invalid parameters. Review the error message and verify credentials and inputs.

To resolve errors:

  • Validate all JSON inputs using online validators.
  • Confirm the API endpoint URL is reachable.
  • Check that the API key credential is correctly configured in n8n.
  • Follow error messages for specific guidance.

Links and References

Discussion