Lit Protocol · Schema

AddUsageApiKeyWithSignatureResponse

Returned by `/add_usage_api_key_with_signature`. The client must follow up with on-chain `registerWalletDerivation(adminHash, wallet_address, derivation_path, name, description)` and `setUsageApiKey(adminHash, keccak256(usage_api_key), …)` — both signed by the admin wallet — to attach the usage key to the ChainSecured account.

Web3Key ManagementMPCProgrammable KeysLit Actions

Properties

Name Type Description
usage_api_key string Base64-encoded 32-byte secret. Send as `X-Api-Key` / `Authorization: Bearer …` for usage requests; pass `keccak256(this)` to `setUsageApiKey`.
wallet_address string 0x-prefixed lowercase hex EVM address of the minted PKP wallet.
derivation_path string 0x-prefixed lowercase hex (uint256). Pass through verbatim to `registerWalletDerivation`'s `derivationPath` arg.
View JSON Schema on GitHub

JSON Schema

lit-protocol-addusageapikeywithsignatureresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AddUsageApiKeyWithSignatureResponse",
  "title": "AddUsageApiKeyWithSignatureResponse",
  "description": "Returned by `/add_usage_api_key_with_signature`. The client must follow up with on-chain `registerWalletDerivation(adminHash, wallet_address, derivation_path, name, description)` and `setUsageApiKey(adminHash, keccak256(usage_api_key), \u2026)` \u2014 both signed by the admin wallet \u2014 to attach the usage key to the ChainSecured account.",
  "type": "object",
  "required": [
    "derivation_path",
    "usage_api_key",
    "wallet_address"
  ],
  "properties": {
    "usage_api_key": {
      "description": "Base64-encoded 32-byte secret. Send as `X-Api-Key` / `Authorization: Bearer \u2026` for usage requests; pass `keccak256(this)` to `setUsageApiKey`.",
      "type": "string"
    },
    "wallet_address": {
      "description": "0x-prefixed lowercase hex EVM address of the minted PKP wallet.",
      "type": "string"
    },
    "derivation_path": {
      "description": "0x-prefixed lowercase hex (uint256). Pass through verbatim to `registerWalletDerivation`'s `derivationPath` arg.",
      "type": "string"
    }
  }
}