Overview
This node integrates with the Nevermined platform to manage AI agent registrations and their associated payment plans. Specifically, the Register Agent and Plan operation allows users to register a new AI agent along with a payment plan that defines pricing, credits, currency, and other options.
Typical use cases include:
- Deploying an AI service or agent that requires subscription or pay-per-use billing.
- Setting up access control for AI APIs by defining credit-based usage plans.
- Automating the registration of agents and their payment plans within workflows.
For example, a company launching an AI chatbot can use this node to register the chatbot as an agent on Nevermined, specify its API endpoint, set a fixed price per usage plan, define how many credits are included, and configure webhook URLs for notifications.
Properties
| Name | Meaning |
|---|---|
| Agent Metadata | JSON metadata describing the agent, including fields like name, description, tags (array of strings), and links (array of URLs). This metadata characterizes the AI agent being registered. |
| API Endpoint | The URL of the API endpoint where the agent is accessible. This is required and typically points to the deployed AI service's base URL. |
| Additional Options | A collection of optional settings for the payment plan: - Price: Numeric cost users pay to access the agent. - Credits: Number of credits included in the plan; each API call usually consumes one credit. - Currency: Pricing currency, either "USD" or "Custom Token". - Token Address: ERC-20 token contract address if using a custom token. - Credits Validity Days: Number of days credits remain valid (0 means no expiration). - Public Agent: Boolean indicating if the agent is publicly accessible. - Webhook URL: URL to receive webhook notifications related to this agent. |
Output
The output JSON object contains detailed information about the registered agent and its payment plan, including:
agentId: Unique identifier assigned to the agent by Nevermined.planId: Identifier of the created payment plan.metadata: The parsed agent metadata JSON.apiEndpoint: The API endpoint URL provided.plan: Object containing pricing details (price), number of credits (credits), currency, and validity period (validityDays).isPublic: Boolean indicating if the agent is publicly accessible.webhookUrl: Configured webhook URL for notifications.registeredAt: Timestamp of registration.environment: The environment used ("production" or "test").status: Status string, e.g.,"registered".message: Human-readable message confirming successful registration.
If registration fails, the node throws an error with descriptive messages.
Dependencies
- Requires an API key credential for authenticating with the Nevermined platform.
- The node makes HTTP requests to the Nevermined API endpoints, which differ based on environment (production or test).
- Proper network connectivity to the Nevermined API endpoint is necessary.
- The user must provide a valid API endpoint URL for the AI agent.
Troubleshooting
- Invalid JSON in Agent Metadata: If the metadata JSON is malformed, the node will throw an error specifying the issue. Ensure the JSON is correctly formatted.
- Missing API Endpoint: The API endpoint URL is mandatory. Omitting it causes an error.
- API Key Issues: If the API key is missing or invalid, the node will fail authentication. Verify the API key credential is configured properly.
- HTTP Errors from API: The node surfaces HTTP status codes and error messages returned by the Nevermined API. Common issues include unauthorized access, invalid parameters, or server errors.
- Network Connectivity: Failure to reach the Nevermined API endpoint will cause request failures. Check network and firewall settings.
- Currency and Token Address: When using a custom token currency, ensure the ERC-20 token address is valid and correctly formatted.
Links and References
- Nevermined Documentation — Official docs for the Nevermined platform and API.
- ERC-20 Token Standard — Information about Ethereum token contracts, relevant when using custom tokens for payments.