Skip to main content

Commands

The plugin provides slash commands for chat channels and gateway methods for programmatic access. Each command is available in both forms.

Authentication

/nvm_login [environment]

Authenticate with Nevermined via browser login.
ParameterTypeRequiredDefaultDescription
environmentstringNosandboxsandbox or live
Example:
/nvm_login
/nvm_login live
/nvm_login sandbox:eyJhbG...

/nvm_logout

Log out from Nevermined and remove the stored API key.

Subscriber Tools

These tools are for users who want to subscribe to plans, check balances, and query agents.

nevermined_checkBalance

Check the credit balance for a payment plan.
ParameterTypeRequiredDefaultDescription
planIdstringNoConfig planIdThe payment plan ID to check
Returns:
{
  "planId": "did:nv:abc123...",
  "planName": "Basic Plan",
  "balance": "95",
  "isSubscriber": true
}

nevermined_getAccessToken

Get an x402 access token for authenticating requests to a Nevermined agent.
ParameterTypeRequiredDefaultDescription
planIdstringNoConfig planIdThe payment plan ID
agentIdstringNoConfig agentIdThe agent ID
Returns:
{
  "accessToken": "eyJhbG..."
}

nevermined_orderPlan

Purchase (order) a Nevermined payment plan.
ParameterTypeRequiredDefaultDescription
planIdstringNoConfig planIdThe plan ID to purchase
Returns: Order confirmation with transaction hash.

nevermined_queryAgent

End-to-end agent query: acquires an x402 access token, sends the prompt to the agent URL with the PAYMENT-SIGNATURE header, and returns the response.
ParameterTypeRequiredDefaultDescription
agentUrlstringYesThe URL of the agent to query
promptstringYesThe prompt to send to the agent
planIdstringNoConfig planIdThe payment plan ID
agentIdstringNoConfig agentIdThe agent ID
methodstringNoPOSTHTTP method
If the agent returns a 402 (Payment Required) response, the tool returns an error indicating insufficient credits.

Builder Tools

These tools are for agent builders who want to register agents and create payment plans.

nevermined_registerAgent

Register a new AI agent with an associated payment plan.
ParameterTypeRequiredDescription
namestringYesAgent name
descriptionstringNoAgent description
agentUrlstringYesThe endpoint URL for the agent
planNamestringYesName for the payment plan
priceAmountsstringYesComma-separated price amounts in wei
priceReceiversstringYesComma-separated receiver addresses
creditsAmountnumberYesNumber of credits in the plan
tokenAddressstringNoERC20 token address (e.g. USDC). Omit for native token.
Returns:
{
  "agentId": "did:nv:...",
  "planId": "did:nv:...",
  "txHash": "0x..."
}

nevermined_createPlan

Create a standalone payment plan (without an agent).
ParameterTypeRequiredDescription
namestringYesPlan name
descriptionstringNoPlan description
priceAmountsstringYesComma-separated price amounts in wei
priceReceiversstringYesComma-separated receiver addresses
creditsAmountnumberYesNumber of credits in the plan
accessLimitstringNo"credits" (default) or "time"
tokenAddressstringNoERC20 token address (e.g. USDC). Omit for native token.
Returns:
{
  "planId": "did:nv:..."
}

nevermined_listPlans

List the builder’s payment plans. No parameters required. Returns: Array of plan objects.