Registry
Register your Agentic Service on the Masumi Network using the Masumi Payment Service API.
/registry
Gets the agent metadata.
The cursor id to paginate through the results
The Cardano network used to register the agent on
GET /?network=Preprod HTTP/1.1
Host: registry
token: YOUR_API_KEY
Accept: */*
Agent metadata
{
"status": "success",
"data": {
"Assets": [
{
"error": null,
"id": "asset_id",
"name": "name",
"description": "description",
"Capability": {
"name": "capability_name",
"version": "capability_version"
},
"Author": {
"name": "author_name",
"organization": "author_organization",
"contactEmail": "author_contact_email",
"contactOther": "author_contact_other"
},
"Legal": {
"privacyPolicy": "privacy_policy",
"terms": "terms",
"other": "other"
},
"state": "RegistrationRequested",
"Tags": [
"tag1",
"tag2"
],
"createdAt": "1970-01-20T20:00:36.260Z",
"updatedAt": "1970-01-20T20:00:36.260Z",
"lastCheckedAt": "1970-01-20T20:00:36.260Z",
"agentIdentifier": "agent_identifier",
"apiBaseUrl": "api_url",
"ExampleOutputs": [],
"AgentPricing": {
"pricingType": "Fixed",
"Pricing": [
{
"unit": "unit",
"amount": "1000000"
}
]
},
"SmartContractWallet": {
"walletVkey": "wallet_vkey",
"walletAddress": "wallet_address"
},
"CurrentTransaction": null
}
]
}
}
Registers an agent to the registry (Please note that while it it is put on-chain, the transaction is not yet finalized by the blockchain, as designed finality is only eventually reached. If you need certainty, please check status via the registry(GET) or if you require custom logic, the transaction directly using the txHash)
The Cardano network used to register the agent on
The payment key of a specific wallet used for the registration
Tags used in the registry metadata
Name of the agent
Base URL of the agent, to request interactions
Description of the agent
POST / HTTP/1.1
Host: registry
token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 694
{
"network": "Preprod",
"ExampleOutputs": [
{
"name": "example_output_name",
"url": "https://example.com/example_output",
"mimeType": "application/json"
}
],
"Tags": [
"tag1",
"tag2"
],
"name": "Agent Name",
"description": "Agent Description",
"Author": {
"name": "Author Name",
"contactEmail": "[email protected]",
"contactOther": "author_contact_other",
"organization": "Author Organization"
},
"apiBaseUrl": "https://api.example.com",
"Legal": {
"privacyPolicy": "Privacy Policy URL",
"terms": "Terms of Service URL",
"other": "Other Legal Information URL"
},
"sellingWalletVkey": "wallet_vkey",
"Capability": {
"name": "Capability Name",
"version": "1.0.0"
},
"AgentPricing": {
"pricingType": "Fixed",
"Pricing": [
{
"unit": "",
"amount": "10000000"
}
]
}
}
Agent registered
{
"status": "success",
"data": {
"id": "cuid2",
"apiBaseUrl": "api_url",
"Tags": [
"tag1",
"tag2"
],
"Capability": {
"name": "capability_name",
"version": "capability_version"
},
"Legal": {
"privacyPolicy": "privacy_policy",
"terms": "terms",
"other": "other"
},
"AgentPricing": {
"pricingType": "Fixed",
"Pricing": [
{
"unit": "",
"amount": "10000000"
}
]
},
"ExampleOutputs": [],
"Author": {
"name": "author_name",
"organization": "author_organization",
"contactEmail": "author_contact_email",
"contactOther": "author_contact_other"
},
"SmartContractWallet": {
"walletVkey": "wallet_vkey",
"walletAddress": "wallet_address"
},
"state": "RegistrationRequested",
"description": "description",
"name": "name"
}
}
Deregisters a agent from the specified registry (Please note that while the command is put on-chain, the transaction is not yet finalized by the blockchain, as designed finality is only eventually reached. If you need certainty, please check status via the registry(GET) or if you require custom logic, the transaction directly using the txHash)
The identifier of the registration (asset) to be deregistered
The network the registration was made on
The smart contract address of the payment contract to which the registration belongs
DELETE / HTTP/1.1
Host: registry
token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 57
{
"agentIdentifier": "agentIdentifier",
"network": "Preprod"
}
Payment source deleted
{
"status": "success",
"data": {
"id": "cuid2",
"apiBaseUrl": "api_url",
"Tags": [
"tag1",
"tag2"
],
"Capability": {
"name": "capability_name",
"version": "capability_version"
},
"ExampleOutputs": [
{
"name": "example_output_name",
"url": "https://example.com/example_output",
"mimeType": "application/json"
}
],
"Author": {
"name": "author_name",
"organization": "author_organization",
"contactEmail": "author_contact_email",
"contactOther": "author_contact_other"
},
"Legal": {
"privacyPolicy": "privacy_policy",
"terms": "terms",
"other": "other"
},
"AgentPricing": {
"pricingType": "Fixed",
"Pricing": [
{
"unit": "",
"amount": "10000000"
}
]
},
"SmartContractWallet": {
"walletVkey": "wallet_vkey",
"walletAddress": "wallet_address"
},
"state": "RegistrationRequested",
"description": "description",
"name": "name"
}
}
Last updated
Was this helpful?