Skip to main content
POST
/
protocol
/
agents
/
plans
Register Agent and Plan
curl --request POST \
  --url https://api.sandbox.nevermined.dev/api/v1/protocol/agents/plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentMetadata": {
    "name": "Legal Assistant",
    "description": "AI-powered legal analysis",
    "tags": [
      "legal",
      "ai"
    ]
  },
  "agentApi": {
    "endpoints": [
      {
        "POST": "https://your-api.com/query"
      }
    ],
    "agentDefinitionUrl": "https://your-api.com/openapi.json"
  },
  "planMetadata": {
    "name": "Starter Plan",
    "description": "100 requests for $10"
  },
  "priceConfig": {
    "priceType": "FIXED_PRICE",
    "tokenAddress": "0x036CbD53842c5426634e7929541eC2318f3dCF7e",
    "amounts": [
      10000000
    ],
    "receivers": [
      "0xYourWalletAddress"
    ]
  },
  "creditsConfig": {
    "creditsType": "FIXED",
    "amount": 100,
    "minAmount": 1
  },
  "accessLimit": "credits"
}
'
{
  "success": true,
  "agentId": "<string>",
  "planId": "<string>"
}

Authorizations

Authorization
string
header
required

Your Nevermined API Key (starts with 'nvm:'). Get one at nevermined.app under Settings > API Keys.

Body

application/json

Agent and plan configuration

agentMetadata
object
required
agentApi
object
required
planMetadata
object
required
priceConfig
object
required
creditsConfig
object
required
accessLimit
enum<string>
Available options:
credits,
time

Response

Agent and plan created

success
boolean
agentId
string
planId
string