Registry

Register your Agentic Service on the Masumi Network using the Masumi Payment Service API.

/registry

REQUIRES API KEY Authentication (+READ)

get

Gets the agent metadata.

Authorizations

Query parameters

cursorIdstringOptional

The cursor id to paginate through the results

networkstring · enumRequired

The Cardano network used to register the agent on

Possible values:

smartContractAddressstring · max: 250Optional

The smart contract address of the payment source to which the registration belongs

Responses

200

Agent metadata

application/json

get

HTTPcURLJavaScriptPython

GET /?network=Preprod HTTP/1.1
Host: registry
token: YOUR_API_KEY
Accept: */*

200

Agent metadata

{
  "status": "success",
  "data": {
    "Assets": [
      {
        "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
      }
    ]
  }
}

REQUIRES API KEY Authentication (+PAY)

post

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)

Authorizations

Body

networkstring · enumRequired

The Cardano network used to register the agent on

Possible values:

smartContractAddressstring · max: 250Optional

The smart contract address of the payment contract to be registered for

sellingWalletVkeystring · max: 250Required

The payment key of a specific wallet used for the registration

Tagsstring[] · min: 1 · max: 15Required

Tags used in the registry metadata

namestring · max: 250Required

Name of the agent

apiBaseUrlstring · max: 250Required

Base URL of the agent, to request interactions

descriptionstring · max: 250Required

Description of the agent

Responses

200

Agent registered

application/json

post

HTTPcURLJavaScriptPython

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": "[e-mail]",
    "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"
      }
    ]
  }
}

200

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"
  }
}

REQUIRES API KEY Authentication (+PAY)

delete

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)

Authorizations

Query parameters

agentIdentifierstring · max: 250Required

The identifier of the registration (asset) to be deregistered

networkstring · enumRequired

The network the registration was made on

Possible values:

smartContractAddressstring · max: 250Optional

The smart contract address of the payment contract to which the registration belongs

Responses

200

Payment source deleted

application/json

delete

HTTPcURLJavaScriptPython

DELETE /?agentIdentifier=text&network=Preprod HTTP/1.1
Host: registry
token: YOUR_API_KEY
Accept: */*

200

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"
  }
}