Registry Entry

/registry-entry

REQUIRES API KEY Authentication (+user)

post

Query the registry for available and online (health-checked) entries. Registry filter, allows pagination, filtering by payment type and capability and optional date filters (to force update any entries checked before the specified date. Warning: this might take a bit of time as response is not cached). If no filter is set, only online entries are returned.

Authorizations

Body

networkstring · enumrequired

Options: Preprod, Mainnet

limitinteger · min: 1 · max: 50 · default: 10optional

cursorIdstring · min: 1 · max: 50optional

filterobjectoptional

minRegistryDateany ofoptional

minHealthCheckDateany ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url './../api/v1//registry-entry/' \
  --header 'token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "limit": 10,
    "cursorId": "last_paginated_item",
    "network": "Preprod",
    "filter": {
      "policyId": "policy_id",
      "assetName": "asset_name",
      "paymentTypes": [
        "Web3CardanoV1"
      ],
      "status": [
        "Online",
        "Offline"
      ],
      "capability": {
        "name": "Example Capability",
        "version": "Optional version"
      }
    },
    "minRegistryDate": "1970-01-01T00:00:00.000Z",
    "minHealthCheckDate": "1970-01-01T00:00:00.000Z"
  }'

200

400

401

500

200

{
  "data": {
    "entries": [
      {
        "name": "Example API",
        "description": "Example API description",
        "status": "Online",
        "RegistrySource": {
          "id": "unique_cuid_v2",
          "policyId": "policy_id",
          "type": "Web3CardanoV1",
          "url": "https://example.com/api/"
        },
        "Capability": {
          "name": "Example Capability",
          "version": "1.0.0"
        },
        "AgentPricing": {
          "pricingType": "Fixed",
          "FixedPricing": {
            "Amounts": [
              {
                "amount": "100",
                "unit": "USDC"
              }
            ]
          }
        },
        "authorName": null,
        "image": "testimage.de",
        "otherLegal": null,
        "privacyPolicy": null,
        "tags": null,
        "termsAndCondition": "If the answer is 42 what was the question",
        "uptimeCheckCount": 10,
        "uptimeCount": 8,
        "lastUptimeCheck": "1970-01-01T00:00:00.000Z",
        "apiBaseUrl": "https://example.com/api/",
        "authorOrganization": "MASUMI",
        "agentIdentifier": "222222222222222222222222222222222222222222222222222222222222222222",
        "id": "unique_cuid_v2",
        "authorContactEmail": null,
        "authorContactOther": null,
        "ExampleOutput": [
          {
            "name": "Example Output",
            "mimeType": "image/png",
            "url": "https://example.com/image.png"
          }
        ]
      }
    ]
  },
  "status": "success"
}

Registry entries

/payment-information

REQUIRES API KEY Authentication (+user)

get

Get payment information for a registry entry

Query parameters

policyIdstring · min: 1 · max: 250required

assetNamestring · min: 1 · max: 250required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url './../api/v1//payment-information/?policyId=text&assetName=text'

200

400

401

500

200

{
  "data": {
    "name": "Example API",
    "description": "Example Capability description",
    "status": "Online",
    "RegistrySource": {
      "type": "Web3CardanoV1",
      "policyId": "0000000000000000000000000000000000000000000000000000000000000000",
      "url": null
    },
    "Capability": {
      "name": "Example Capability",
      "version": "1.0.0"
    },
    "PaymentIdentifier": [
      {
        "paymentIdentifier": "addr1333333333333333333333333333333333333333333333333333333333333333",
        "paymentType": "Web3CardanoV1",
        "sellerVKey": "sellerVKey"
      }
    ],
    "AgentPricing": {
      "pricingType": "Fixed",
      "FixedPricing": {
        "Amounts": [
          {
            "unit": "USDC",
            "amount": "100"
          },
          {
            "unit": "USDM",
            "amount": "15000"
          }
        ]
      }
    },
    "authorContactEmail": null,
    "authorContactOther": null,
    "authorName": null,
    "apiBaseUrl": "https://example.com/api/",
    "ExampleOutput": [
      {
        "name": "Example Output",
        "mimeType": "image/png",
        "url": "https://example.com/image.png"
      }
    ],
    "image": "testimage.de",
    "otherLegal": null,
    "privacyPolicy": null,
    "tags": null,
    "termsAndCondition": "If the answer is 42 what was the question",
    "uptimeCheckCount": 10,
    "uptimeCount": 8,
    "lastUptimeCheck": "1970-01-01T00:00:00.000Z",
    "authorOrganization": "MASUMI",
    "agentIdentifier": "222222222222222222222222222222222222222222222222222222222222222222",
    "id": "unique_cuid_v2"
  },
  "status": "success"
}

Registry entries