Sign in
inbox-agents

Registers an inbox agent to the registry (+PAY access required)

Changed on

Registers an inbox agent to the registry (Please note that while it is put on-chain, the transaction is not yet finalized by the blockchain.)

post/inbox-agents

Request

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

Request body

network'Preprod' | 'Mainnet' required

The Cardano network used to register the inbox agent on

sellingWalletVkeystring required

The payment key of a specific wallet used for the registration

recipientWalletAddressstring

Optional managed hot wallet address on the same payment source that should receive the minted inbox registry NFT. If omitted, the minting wallet receives it.

sendFundingLovelacestring

Optional lovelace amount to include with the minted inbox registry NFT output. If provided below the minimum NFT funding, the current minimum is still used.

namestring required

Display name of the inbox agent

descriptionstring

Optional description of the inbox agent

agentSlugstring required

Canonical inbox slug. Must already be normalized and not reserved

Example request

{
  "network": "Preprod",
  "sellingWalletVkey": "wallet_vkey",
  "recipientWalletAddress": "recipient_wallet_address",
  "sendFundingLovelace": "7500000",
  "name": "Inbox Agent",
  "description": "Masumi inbox identity registration",
  "agentSlug": "inbox-agent"
}

Response

Inbox agent registered

status'success' required

Example response

{
  "status": "success",
  "data": {
    "error": null,
    "id": "inbox_registry_id",
    "name": "Inbox Agent",
    "description": "Masumi inbox identity registration",
    "agentSlug": "inbox-agent",
    "state": "RegistrationRequested",
    "createdAt": "1970-01-20T20:00:36.260Z",
    "updatedAt": "1970-01-20T20:00:36.260Z",
    "lastCheckedAt": null,
    "agentIdentifier": "policy_id_asset_name_policy_id_asset_name_policy_id_asset_name",
    "metadataVersion": 1,
    "sendFundingLovelace": null,
    "SmartContractWallet": {
      "walletVkey": "wallet_vkey",
      "walletAddress": "wallet_address"
    },
    "RecipientWallet": null,
    "CurrentTransaction": null
  }
}

Changes

  • 315a2a763fb7Revision changes
    • breaking

      added the pattern ^(addr1|addr_test1)[0-9a-z]+$ to the request property

  • b63a7da9c361Revision changes
    • info

      removed the pattern ^(addr1|addr_test1)[0-9a-z]+$ from the request property