Sign in
registry

Delete an agent registration record. (admin access required)

Changed on

Permanently deletes an agent registration record from the database. This action is irreversible and should only be used for registrations in specific failed or completed states.

delete/registry

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/registry
  • Auth: API key in header token

Request body

idstring cuid required

The database ID of the agent registration record to be deleted.

Example request

{
  "id": "example_id"
}

Response

Agent registration deleted successfully

statusstring required

Example response

{
  "status": "Success",
  "data": {
    "error": null,
    "id": "registry_id",
    "name": "Agent Name",
    "description": "Agent Description",
    "type": "Standard",
    "apiBaseUrl": "https://api.example.com",
    "openApiSpecUrl": null,
    "x402ResourcesUrl": null,
    "a2aAgentCardUrl": null,
    "a2aProtocolVersions": [],
    "paymentSourceType": "Web3CardanoV1",
    "Capability": {
      "name": "Capability Name",
      "version": "1.0.0"
    },
    "Author": {
      "name": "Author Name",
      "contactEmail": "author@example.com",
      "contactOther": "contact-other",
      "organization": "Author Org"
    },
    "Legal": {
      "privacyPolicy": "https://example.com/privacy",
      "terms": "https://example.com/terms",
      "other": "https://example.com/other"
    },
    "state": "RegistrationRequested",
    "Tags": [
      "tag1",
      "tag2"
    ],
    "createdAt": "1970-01-20T20:00:36.260Z",
    "updatedAt": "1970-01-20T20:00:36.260Z",
    "lastCheckedAt": null,
    "ExampleOutputs": [
      {
        "name": "example_output_name",
        "url": "https://example.com/example_output",
        "mimeType": "application/json"
      }
    ],
    "agentIdentifier": "policy_id_asset_name_policy_id_asset_name_policy_id_asset_name",
    "AgentPricing": {
      "pricingType": "Fixed",
      "Pricing": [
        {
          "unit": "",
          "amount": "10000000"
        }
      ]
    },
    "sendFundingLovelace": null,
    "supportedPaymentSources": [
      {
        "chain": "Cardano",
        "network": "Preprod",
        "paymentSourceType": "Web3CardanoV2",
        "address": "addr_test1wz7j4kmg2cs7yf92uat3ed4a3u97kr7axxr4avaz0lhwdsqukgwfm",
        "pricing": {
          "pricingType": "Fixed",
          "fixed": [
            {
              "asset": "",
              "amount": "1000000"
            }
          ]
        }
      }
    ],
    "verifications": [
      {
        "method": "KERI-ACDC",
        "schemaVersion": "1",
        "issuer": {
          "aid": "EIaIeKvfBLmZf3wfqB0oR1uM5n8m9k2pQ7rT4sV1wX3y",
          "oobi": "https://witness.example.com/oobi/EIaIeKvfBLmZf3wfqB0oR1uM5n8m9k2pQ7rT4sV1wX3y/witness"
        },
        "schema": {
          "said": "EJ1gXWfzLyW2u0YY5Zb8c4d6e9f1g3h5j7k9l2m4n6p",
          "oobi": "https://schema.example.com/oobi/EJ1gXWfzLyW2u0YY5Zb8c4d6e9f1g3h5j7k9l2m4n6p"
        },
        "credential": {
          "said": "EHpH79tPZoSl7VJZ7xMi3JWF4rH9wZ2ntGvKABd9N14z",
          "oobi": "https://cred.example.com/oobi/EHpH79tPZoSl7VJZ7xMi3JWF4rH9wZ2ntGvKABd9N14z",
          "registry": "ER7yQ3kL9mN2pT5vX8a1b4c7d0e3f6g9h2j5k8l1m4n7"
        },
        "holder": {
          "aid": "EBcd1ef2gh3ij4kl5mn6op7qr8st9uv0wx1yz2ab3cd4",
          "oobi": "https://keria.example.com/oobi/EBcd1ef2gh3ij4kl5mn6op7qr8st9uv0wx1yz2ab3cd4/agent/EAgnt"
        },
        "baseUrl": "https://verify.example.com"
      }
    ],
    "SmartContractWallet": {
      "walletVkey": "wallet_vkey",
      "walletAddress": "wallet_address"
    },
    "RecipientWallet": null,
    "CurrentTransaction": null
  }
}

Changes

  • 3a78f1888f27Revision changes
    • warning

      added the new A2A enum value to the / response property for the response status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • 7c7d80747ca0Revision changes
    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      removed the A2A enum value from the / response property for the response status