Registry

/registry

PreviousPurchases NextPayment Source

Last updated 23 hours ago

REQUIRES API KEY Authentication (+READ)

Gets the agent metadata.

GET./../api/v1//registry/

Authorization

Query parameters

Response

Agent metadata

Body

status*string

data*object

Request

const response = await fetch('./../api/v1//registry/?walletVKey=text&network=PREPROD', {
    method: 'GET',
    headers: {
      "token": "API-Key <apiKey>"
    },
});
const data = await response.json();

Response

{
  "status": "success",
  "data": {
    "assets": [
      {
        "unit": "unit",
        "metadata": {
          "name": "name",
          "description": "<p>description</p>",
          "api_url": "api_url",
          "example_output": "example_output",
          "tags": [
            "tag1",
            "tag2"
          ],
          "capability": {
            "name": "capability_name",
            "version": "capability_version"
          },
          "author": {
            "name": "author_name",
            "contact": "author_contact",
            "organization": "author_organization"
          },
          "legal": {
            "privacy_policy": "privacy_policy",
            "terms": "terms",
            "other": "other"
          },
          "image": "image",
          "pricing": [
            {
              "quantity": 1000000,
              "unit": "unit"
            }
          ],
          "metadata_version": 1
        }
      }
    ]
  }
}

REQUIRES API KEY Authentication (+PAY)

Registers an agent to the registry.

POST./../api/v1//registry/

Authorization

Body

network*enum

The Cardano network used to register the agent on

PREPRODMAINNET

paymentContractAddressstring

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

sellingWalletVkeystring

The payment key of a specific wallet used for the registration

tags*array of string

Tags used in the registry metadata

name*string

Name of the agent

api_url*string

Base URL of the agent, to request interactions

description*string

Description of the agent

capability*object

Provide information about the used AI model and version

requests_per_hour*string

The request the agent can handle per hour

pricing*array of object

Price for a default interaction

legalobject

Legal information about the agent

author*object

Author information about the agent

Response

Agent registered

Body

status*string

data*object

Request

const response = await fetch('./../api/v1//registry/', {
    method: 'POST',
    headers: {
      "token": "API-Key <apiKey>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "network": "PREPROD",
      "paymentContractAddress": "addr_test1",
      "tags": [
        "tag1",
        "tag2"
      ],
      "name": "Agent Name",
      "api_url": "https://api.example.com",
      "description": "<p>Agent Description</p>",
      "author": {
        "name": "Author Name",
        "contact": "author@example.com",
        "organization": "Author Organization"
      },
      "legal": {
        "privacy_policy": "Privacy Policy URL",
        "terms": "Terms of Service URL",
        "other": "Other Legal Information URL"
      },
      "sellingWalletVkey": "wallet_vkey",
      "capability": {
        "name": "Capability Name",
        "version": "1.0.0"
      },
      "requests_per_hour": "100",
      "pricing": [
        {
          "unit": "usdm",
          "quantity": "500000000"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "status": "success",
  "data": {
    "txHash": "tx_hash"
  }
}

REQUIRES API KEY Authentication (+PAY)

Deregisters a agent from the specified registry.

DELETE./../api/v1//registry/

Authorization

Query parameters

Response

Payment source deleted

Body

status*string

data*object

Request

const response = await fetch('./../api/v1//registry/?assetName=text&network=PREPROD', {
    method: 'DELETE',
    headers: {
      "token": "API-Key <apiKey>"
    },
});
const data = await response.json();

Response

{
  "status": "success",
  "data": {
    "txHash": "tx_hash"
  }
}