@vapi-network/core
v0.9.0
Published
Non-custodial x402 protocol, wallet policy, discovery, and receipts core
Readme
@vapi-network/core
The non-custodial heart of vAPI Network: the x402 protocol, the wallet store, spend policy, the network guard, discovery merge, public documentation access and the append-only receipt ledger. Keys stay on the caller's machine. This package proxies no payment and sends no telemetry.
Seven entry points: @vapi-network/core, @vapi-network/core/secrets, @vapi-network/core/backup, @vapi-network/core/cloud-backup, @vapi-network/core/api-key, @vapi-network/core/agent-link and @vapi-network/core/router-client.
@vapi-network/core, everything an agent-driven surface may use: accounts, balances,WalletStore,SpendPolicy,resolvePassphrase, receipts, stats and the x402 primitives.@vapi-network/core/secrets, human-only.exportRecoveryPhrase,exportKeystoreKeys,createKeystoreWithPhraseanddecryptPrivateKeyreturn a recovery phrase or a private key, so they are deliberately not re-exported from the main index and the MCP package is forbidden to import them.@vapi-network/core/backupcreates, opens, exports and restores encrypted vault backups, derives owner keys, and seals relay payloads. The MCP package is forbidden to import it.@vapi-network/core/cloud-backupruns owner relays, stores per-device backup keys, uploads envelopes and restores owner-approved backups. The MCP package is forbidden to import it.- The
@vapi-network/core/api-keyentry point stores and resolves the registry API key without placing it in parsed MCP configuration. - The
@vapi-network/core/agent-linkentry point handles device linking and agent tokens for a wallet. - The
@vapi-network/core/router-cliententry point lists router models, reads usage and buys router balance.
Exports
Runtime exports
| Name | What it is | Since |
| ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
| activeAgentMarker | function (env: NodeJS.ProcessEnv): AgentMarker | undefined | 0.5.0 or earlier |
| AGENT_MARKER_VARIABLES | constant AGENT_MARKER_VARIABLES: readonly ["VAPI_NO_SECRETS", "CLAUDECODE", "CLAUDE_CODE", "CURSOR_AGENT", "CODEX_SANDBOX", "OPENAI_CODEX", "AGENT", "CI"] | 0.5.0 or earlier |
| agentProfileSchema | constant agentProfileSchema: ZodObject<{ version: ZodLiteral<1>; name: ZodString; wallet: ZodString; model: ZodString; instructions: ZodString; verifiedOnly: ZodDefault; ... 4 more ...; createdAt: ZodString; }, $strip> | 0.5.0 or earlier |
| aggregateStats | function (args: { receipts: readonly Receipt[]; searches: readonly SearchEvent[]; range?: StatsRange; now?: Date; }): StatsReport | 0.5.0 or earlier |
| apiMarketplaceHitSchema | constant apiMarketplaceHitSchema: ZodDiscriminatedUnion<[ZodObject<{ kind: ZodLiteral<"api">; provenance: ZodEnum<{ partner: "partner"; self_listed: "self_listed"; }>; execution: ZodObject<{ mode: ZodEnum<{ direct: "direct"; gateway: "gateway"; }>; }, $loos... | 0.5.0 or earlier |
| appendAudit | function (home: string, record: AuditRecord, options: AuditOptions = {}): Promise | 0.5.0 or earlier |
| appendReceipt | function (receipt: Receipt, path = getVapiPaths().receipts, options: { wallet?: string } = {}): Promise | 0.5.0 or earlier |
| appendSearchEvent | function (event: SearchEvent, path = getVapiPaths().searches): Promise | 0.5.0 or earlier |
| ARC_MAINNET_CAIP2 | constant ARC_MAINNET_CAIP2: "eip155:5042" | 0.5.0 |
| ARC_TESTNET_CAIP2 | constant ARC_TESTNET_CAIP2: "eip155:5042002" | 0.5.0 or earlier |
| areSamePaymentNetwork | function (left: string, right: string): boolean | 0.5.0 or earlier |
| assertMaxPrice | function (amountAtomic: bigint, maxPriceUsd: number | string | undefined): unknown | 0.5.0 or earlier |
| assertPublicUrl | function (url: URL, options: { allowPrivateNetwork: boolean; lookup?: LookupFn; timeoutMs?: number }): Promise | 0.5.0 or earlier |
| assertSIWxChallengeBoundToOrigin | function (info: Pick<SIWxExtensionInfo, "domain" | "uri">, responseUrl: string | URL): void | 0.5.0 or earlier |
| assertWalletName | function (value: string): WalletName | 0.5.0 or earlier |
| AUDIT_EVENTS | constant AUDIT_EVENTS: readonly ["secret.export.phrase", "secret.export.key", "wallet.create", "wallet.import", "wallet.remove", "wallet.restore", "wallet.rename", "wallet.default", "wallet.caps", ... 17 more ..., "listing.claim"] | 0.5.0 or earlier |
| AUDIT_FILE | constant AUDIT_FILE: "audit.log" | 0.5.0 or earlier |
| auditLogPath | function (home: string): string | 0.5.0 or earlier |
| BASE_MAINNET_CAIP2 | constant BASE_MAINNET_CAIP2: "eip155:8453" | 0.5.0 or earlier |
| BROWSER_ENABLED_X402_NETWORK_CONFIG | constant BROWSER_ENABLED_X402_NETWORK_CONFIG: X402NetworkConfig | 0.5.0 or earlier |
| buildCompatibleX402Payment | function (args: { account: X402Signer; quote: X402Quote; nowSeconds?: number; nonce?: Hex; fetchImpl?: typeof fetch; paymentId?: string; }): Promise<{ payload: X402PaymentPayload; headers: X402CompatiblePaymentHeaders; paymentId?: string; }> | 0.5.0 or earlier |
| buildEip3009TypedData | function (args: { from: Address; quote: X402Quote; nonce: Hex; nowSeconds: number; }): { authorization: Eip3009Authorization; typedData: X402TypedData } | 0.5.0 or earlier |
| buildPaymentExtensions | function (serverExtensions: Readonly<Record<string, unknown>> | undefined, options: Readonly<{ paymentId?: string }> = {}): Record<string, unknown> | 0.5.0 or earlier |
| buildSIWxProof | function (args: { signer: SIWxSigner; challenge: SIWxChallenge; responseUrl: string | URL; }): Promise<{ payload: SIWxPayload; headers: Readonly<{ "SIGN-IN-WITH-X": string }>; }> | 0.5.0 or earlier |
| buildSupportIssueUrl | function (message: string, version = VAPI_CLIENT_VERSION): string | 0.5.0 or earlier |
| buildX402Payment | function (args: { signer: X402Signer; quote: X402Quote; nowSeconds?: number; nonce?: Hex; fetchImpl?: typeof fetch; paymentId?: string; }): Promise<{ payload: X402PaymentPayload; headers: X402PaymentHeaders; paymentId?: string; }> | 0.5.0 or earlier |
| buyRouterBalance | function (deps: RouterClientDeps & { account: VapiPaymentAccount; config: VapiConfig; caps: SpendCaps; paths?: { ledgerPath?: string; receiptsPath?: string }; now?: Date; }, tierUsd: RouterTopupTier): Promise<{ receipt: Receipt; balance: AgentRouterUsage["b... | 0.5.0 or earlier |
| calculateSweepAmount | function (balanceAtomic: bigint, gasHeadroomAtomic: bigint): bigint | 0.5.0 or earlier |
| CALLABLE_CATEGORIES | constant CALLABLE_CATEGORIES: readonly ["ai", "data", "crypto", "compute", "search"] | 0.5.0 or earlier |
| CALLABLE_CATEGORY_LABELS | constant CALLABLE_CATEGORY_LABELS: { readonly ai: { readonly catalog: "AI / LLM"; readonly publish: "AI and models"; }; readonly data: { readonly catalog: "Data"; readonly publish: "Data"; }; readonly crypto: { readonly catalog: "Crypto"; readonly publish: ... | 0.5.0 or earlier |
| CALLABLE_KIND | constant CALLABLE_KIND: "agent" | 0.5.0 or earlier |
| callableCategorySchema | constant callableCategorySchema: ZodEnum<{ ai: "ai"; data: "data"; crypto: "crypto"; compute: "compute"; search: "search"; }> | 0.5.0 or earlier |
| CANONICAL_X402_USDC_NETWORKS | constant CANONICAL_X402_USDC_NETWORKS: Readonly<{ "eip155:8453": Readonly<{ usdc: 0x${string}; eip712Domain: Readonly<{ name: string; version: string; }>; }>; "eip155:5042": Readonly<{ usdc: 0x${string}; eip712Domain: Readonly<{ name: string; version: s... | 0.5.0 or earlier |
| changeKeystorePassphrase | function (oldPassphrase: string, newPassphrase: string, path = getVapiPaths().keystore): Promise | 0.5.0 or earlier |
| checkReceiptSettlement | function (receipt: Receipt, config: Pick<VapiConfig, "networks" | "allowPrivateNetwork">, options: { fetchImpl?: typeof fetch; lookup?: LookupFn } = {}): Promise | 0.5.0 or earlier |
| classifySettlement | function (value: unknown): X402SettlementOutcome | 0.5.0 or earlier |
| completeX402Payment | function (args: CompleteX402PaymentArgs): Promise<CompleteX402PaymentResult> | 0.5.0 or earlier |
| configSchema | constant configSchema: ZodObject<{ discoveryUrl: ZodURL; marketplaceDiscoveryUrl: ZodDefault; registryFallbacks: ZodOptional<ZodArray<ZodObject<{ discoveryUrl: ZodURL; marketplaceDiscoveryUrl: ZodURL; }, $strip>>>; allowPrivateNetwork: ZodOptional<.... | 0.5.0 or earlier |
| configuredNetworkFor | function (networks: Readonly<Record<string, ConfiguredNetwork>>, network: string): ConfiguredNetwork | undefined | 0.5.0 or earlier |
| createChain | function (network: string, rpcUrl: string): Chain | 0.5.0 or earlier |
| createKeystore | function (passphrase: string, path = getVapiPaths().keystore, options: CreateKeystoreOptions = {}): Promise | 0.5.0 or earlier |
| createKeystoreFromPrivateKey | function (passphrase: string, path = getVapiPaths().keystore, options: { privateKey: string }): Promise | 0.5.0 or earlier |
| createNetworkHttpTransport | function (rpcUrl: string, options: NetworkTransportOptions = {}): HttpTransport | 0.5.0 or earlier |
| createNetworkPublicClient | function (network: string, configured: ConfiguredNetwork, options: NetworkTransportOptions = {}): PublicClient | 0.5.0 or earlier |
| createPaymentId | function (randomBytes: (bytes: Uint8Array) => void = fillRandomBytes): string | 0.5.0 or earlier |
| createPublicFetch | function (options: { allowPrivateNetwork: boolean; lookup?: LookupFn; }): typeof fetch | 0.5.0 or earlier |
| askDocs | function (question: string, options?: DocsRequestOptions): Promise | Unreleased |
| createSIWxMessage | function (challenge: SIWxChallenge, address: Address): string | 0.5.0 or earlier |
| createSupportReport | function (options: CreateSupportReportOptions): Promise | 0.5.0 or earlier |
| decodePaymentRequiredHeader | function (value: string): unknown | 0.5.0 or earlier |
| DEFAULT_ARC_GAS_HEADROOM_ATOMIC | constant DEFAULT_ARC_GAS_HEADROOM_ATOMIC: 50000n | 0.5.0 or earlier |
| DEFAULT_DISCOVERY_URL | constant DEFAULT_DISCOVERY_URL: "https: | 0.5.0 or earlier |
| DEFAULT_DOCS_ORIGIN | constant DEFAULT_DOCS_ORIGIN: "https://docs.vapinetwork.ai" | Unreleased |
| DEFAULT_MARKETPLACE_DISCOVERY_URL | constant DEFAULT_MARKETPLACE_DISCOVERY_URL: "https: | 0.5.0 or earlier |
| DEFAULT_REGISTRY_FALLBACKS | constant DEFAULT_REGISTRY_FALLBACKS: readonly [{ readonly discoveryUrl: "https: | 0.5.0 or earlier |
| DEFAULT_REGISTRY_URL | constant DEFAULT_REGISTRY_URL: "https: | 0.5.0 or earlier |
| DEFAULT_SPEND_CAPS | constant DEFAULT_SPEND_CAPS: { readonly perCallAtomic: "100000"; readonly perDayAtomic: "1000000"; } | 0.5.0 or earlier |
| DEFAULT_WALLET_NAME | constant DEFAULT_WALLET_NAME: "main" | 0.5.0 or earlier |
| deriveEvmPrivateKey | function (seed: Uint8Array, path = EVM_DERIVATION_PATH): Hex | 0.5.0 or earlier |
| deriveSolanaPrivateKey | function (seed: Uint8Array, path = SOLANA_DERIVATION_PATH): Uint8Array | 0.5.0 or earlier |
| discardBody | function (response: Response | null | undefined): void | 0.5.0 or earlier |
| discover | function (sources: readonly Source[], query?: string, options: { searchesPath?: string; now?: Date; nowMs?: () => number; } & SourceSearchOptions = {}): Promise<{ listings: Listing[]; errors: ReadonlyArray<{ source: string; error: unknown }> }> | 0.5.0 or earlier |
| DISCOVERY_CATEGORIES | constant DISCOVERY_CATEGORIES: readonly ["ai", "data", "crypto", "compute", "search", "other"] | 0.5.0 or earlier |
| DiscoveryCatalogError | class DiscoveryCatalogError | 0.5.0 or earlier |
| DocsError | class DocsError with stable invalid_input, host_not_allowed, not_found, timeout and bad_response codes | Unreleased |
| discoveryCategorySchema | constant discoveryCategorySchema: ZodEnum<{ ai: "ai"; data: "data"; crypto: "crypto"; compute: "compute"; search: "search"; other: "other"; }> | 0.5.0 or earlier |
| discoveryEndpointSchema | constant discoveryEndpointSchema: ZodObject<{ name: ZodString; method: ZodString; url: ZodURL; price: ZodString; description: ZodString; operationId: ZodOptional; ... 5 more ...; payment: ZodOptional<...>; }, $loose> | 0.5.0 or earlier |
| discoveryResponseSchema | constant discoveryResponseSchema: ZodObject<{ services: ZodArray<ZodObject<{ verified: ZodBoolean; wrapped: ZodBoolean; price: ZodString; networks: ZodArray; endpoints: ZodArray<...>; ... 10 more ...; tier: ZodEnum<...>; }, $loose>>; }, $loose> | 0.5.0 or earlier |
| discoveryServiceSchema | constant discoveryServiceSchema: ZodObject<{ verified: ZodBoolean; wrapped: ZodBoolean; price: ZodString; networks: ZodArray; endpoints: ZodArray<ZodObject<{ name: ZodString; ... 10 more ...; payment: ZodOptional<...>; }, $loose>>; ... 10 more ..... | 0.5.0 or earlier |
| EIP3009_AUTHORIZATION_STATE_ABI | constant EIP3009_AUTHORIZATION_STATE_ABI: readonly [{ readonly type: "function"; readonly name: "authorizationState"; readonly stateMutability: "view"; readonly inputs: readonly [{ readonly name: "authorizer"; readonly type: "address"; }, { readonly name: "... | 0.5.0 or earlier |
| EIP3009_AUTHORIZATION_TYPES | constant EIP3009_AUTHORIZATION_TYPES: { readonly TransferWithAuthorization: readonly [{ readonly name: "from"; readonly type: "address"; }, { readonly name: "to"; readonly type: "address"; }, { readonly name: "value"; readonly type: "uint256"; }, { ...; }, ... | 0.5.0 or earlier |
| enableDefaultNetwork | function (network: "solana" | "arc", path = getVapiPaths().config, source: NodeJS.ProcessEnv = process.env): Promise | 0.5.0 or earlier |
| enableSolanaKey | function (passphrase: string, path = getVapiPaths().keystore): Promise | 0.5.0 or earlier |
| encryptPrivateKey | function (privateKey: Hex, passphrase: string): Promise | 0.5.0 or earlier |
| entropyToPhrase | function (entropy: Uint8Array): string | 0.5.0 or earlier |
| ERC20_ABI | constant ERC20_ABI: readonly [{ readonly type: "function"; readonly name: "balanceOf"; readonly stateMutability: "view"; readonly inputs: readonly [{ readonly name: "account"; readonly type: "address"; }]; readonly outputs: readonly [{ readonly name: "balan... | 0.5.0 or earlier |
| EVM_DERIVATION_PATH | constant EVM_DERIVATION_PATH: "m/44'/60'/0'/0/0" | 0.5.0 or earlier |
| EXECUTION_MODES | constant EXECUTION_MODES: readonly ["direct", "gateway"] | 0.5.0 or earlier |
| executionModeSchema | constant executionModeSchema: ZodEnum<{ direct: "direct"; gateway: "gateway"; }> | 0.5.0 or earlier |
| explorerAddressUrl | function (network: string, address: string): string | undefined | 0.5.0 or earlier |
| explorerTransactionUrl | function (network: string, hash: string): string | undefined | 0.5.0 or earlier |
| filterReceiptsByRange | function (receipts: readonly Receipt[], range: StatsRange, now = new Date(), wallet?: string): Receipt[] | 0.5.0 or earlier |
| filterReceiptsByWallet | function (receipts: readonly Receipt[], name: WalletName): Receipt[] | 0.5.0 or earlier |
| FIRST_PARTY_PROVENANCES | constant FIRST_PARTY_PROVENANCES: readonly ["self_listed", "partner"] | 0.5.0 or earlier |
| firstPartyProvenanceSchema | constant firstPartyProvenanceSchema: ZodEnum<{ partner: "partner"; self_listed: "self_listed"; }> | 0.5.0 or earlier |
| formatLegacyRegistryRewrites | function (changes: readonly LegacyRegistryRewrite[]): string | 0.5.0 or earlier |
| formatUsdc | function (amountAtomic: bigint): string | 0.5.0 or earlier |
| fundingPageUrl | function (registryUrl: string, address: string, options: FundingPageOptions = {}): string | 0.2.5 |
| generateRecoveryPhrase | function (): string | 0.5.0 or earlier |
| getAgentCashPaths | constant getAgentCashPaths: (directory?: string) => VapiPaths | 0.5.0 or earlier |
| getArcGasHeadroomAtomic | function (): bigint | 0.5.0 or earlier |
| getCanonicalX402Usdc | function (network: string): CanonicalX402UsdcIdentity | undefined | 0.5.0 or earlier |
| getDefaultConfig | function (source: NodeJS.ProcessEnv = process.env, options: DefaultConfigOptions = {}): VapiConfig | 0.5.0 |
| getKeystorePassphrase | function (options?: { confirm?: boolean }): Promise | 0.5.0 or earlier |
| getNetworkDefinition | function (network: string): NetworkDefinition | 0.5.0 or earlier |
| getVapiPaths | function (directory = process.env.VAPI_HOME?.trim() || join(homedir(), ".vapi")): VapiPaths | 0.5.0 or earlier |
| isCallableListing | function (kind: string, category: string): boolean | 0.5.0 or earlier |
| isEvmPaymentRequirements | function (requirements: X402PaymentRequirements): requirements is EvmX402PaymentRequirements | 0.5.0 or earlier |
| isMirroredHit | function (hit: MarketplaceHit): boolean | 0.5.0 or earlier |
| isMissingFile | function (error: unknown): error is NodeJS.ErrnoException | 0.5.0 or earlier |
| isNetworkConfigured | function (networks: VapiConfig["networks"], network: string): boolean | 0.5.0 or earlier |
| isSolanaAddress | function (value: string): boolean | 0.5.0 or earlier |
| isSolanaNetwork | function (network: string): boolean | 0.5.0 or earlier |
| isSupportedPaymentNetwork | function (network: string): boolean | 0.5.0 or earlier |
| isSvmPaymentRequirements | function (requirements: X402PaymentRequirements): requirements is SvmX402PaymentRequirements | 0.5.0 or earlier |
| isValidPaymentId | function (value: unknown): value is string | 0.5.0 or earlier |
| isWalletName | function (value: string): boolean | 0.5.0 or earlier |
| KeystoreError | class KeystoreError | 0.5.0 or earlier |
| listAccounts | function (args: ListAccountsArgs): Promise<AccountInfo[]> | 0.5.0 or earlier |
| listAgentProfiles | function (home: string, options: { warn?: (message: string) => void } = {}): Promise<AgentProfile[]> | 0.5.0 or earlier |
| LISTING_GROUPS | constant LISTING_GROUPS: readonly ["vapi", "added", "partner", "external"] | 0.5.0 or earlier |
| LISTING_VERIFICATIONS | constant LISTING_VERIFICATIONS: readonly ["none", "requested", "verified"] | 0.5.0 or earlier |
| listingConformanceSchema | constant listingConformanceSchema: ZodObject<{ declaredVersion: ZodNullable<ZodUnion<readonly [ZodLiteral<1>, ZodLiteral<2>]>>; versionConformant: ZodBoolean; offerTransport: ZodEnum<...>; issues: ZodArray<...>; }, $loose> | 0.5.0 or earlier |
| listingDisclosureShape | constant listingDisclosureShape: { readonly group: ZodOptional<ZodEnum<{ partner: "partner"; vapi: "vapi"; added: "added"; external: "external"; }>>; readonly fee: ZodOptional<ZodObject<{ bps: ZodNumber; label: ZodString; }, $loose>>; readonly verification:... | 0.5.0 or earlier |
| listingFeeSchema | constant listingFeeSchema: ZodObject<{ bps: ZodNumber; label: ZodString; }, $loose> | 0.5.0 or earlier |
| listingGroupSchema | constant listingGroupSchema: ZodEnum<{ partner: "partner"; vapi: "vapi"; added: "added"; external: "external"; }> | 0.5.0 or earlier |
| listingIdentitySchema | constant listingIdentitySchema: ZodObject<{ erc8004Id: ZodString; reputation: ZodCatch<ZodOptional<ZodObject<{ score: ZodNumber; count: ZodNumber; }, $loose>>>; }, $loose> | 0.5.0 or earlier |
| listingLivenessSchema | constant listingLivenessSchema: ZodObject<{ uptime7d: ZodNumber; latencyP50Ms: ZodNullable; latencyP95Ms: ZodNullable; checks7d: ZodNumber; }, $loose> | 0.5.0 or earlier |
| listingVerificationFieldSchema | constant listingVerificationFieldSchema: ZodCatch<ZodDefault<ZodEnum<{ verified: "verified"; none: "none"; requested: "requested"; }>>> | 0.5.0 or earlier |
| listingVerificationSchema | constant listingVerificationSchema: ZodEnum<{ verified: "verified"; none: "none"; requested: "requested"; }> | 0.5.0 or earlier |
| listServicesResponseSchema | constant listServicesResponseSchema: ZodObject<{ services: ZodArray<ZodObject<{ verified: ZodBoolean; wrapped: ZodBoolean; price: ZodString; networks: ZodArray; endpoints: ZodArray<...>; ... 10 more ...; tier: ZodEnum<...>; }, $loose>>; }, $loose> | 0.5.0 or earlier |
| loadConfig | function (path = getVapiPaths().config, source: NodeJS.ProcessEnv = process.env, options: LoadConfigOptions = {}): Promise | 0.5.0 or earlier |
| LocalWallet | class LocalWallet | 0.5.0 or earlier |
| MARKETPLACE_DISCOVERY_PROTOCOL | constant MARKETPLACE_DISCOVERY_PROTOCOL: "vapi.marketplace.discovery/1" | 0.5.0 or earlier |
| MARKETPLACE_EXECUTION_METHODS | constant MARKETPLACE_EXECUTION_METHODS: readonly ["GET", "HEAD", "POST", "PUT", "PATCH", "DELETE"] | 0.5.0 or earlier |
| MARKETPLACE_KINDS | constant MARKETPLACE_KINDS: readonly ["api", "service_offer", "open_request"] | 0.5.0 or earlier |
| MARKETPLACE_RANKING_VERSION | constant MARKETPLACE_RANKING_VERSION: "marketplace-ranking-v1" | 0.5.0 or earlier |
| marketplaceBadgeCodeSchema | constant marketplaceBadgeCodeSchema: ZodEnum<{ partner: "partner"; live_x402: "live_x402"; payout_wallet_confirmed: "payout_wallet_confirmed"; vapi_verified: "vapi_verified"; external_catalog: "external_catalog"; approved_vendor: "approved_vendor"; }> | 0.5.0 or earlier |
| marketplaceBadgeSchema | constant marketplaceBadgeSchema: ZodObject<{ code: ZodEnum<{ partner: "partner"; live_x402: "live_x402"; payout_wallet_confirmed: "payout_wallet_confirmed"; vapi_verified: "vapi_verified"; external_catalog: "external_catalog"; approved_vendor: "approved_ven... | 0.5.0 or earlier |
| marketplaceDiscoveryInputSchema | constant marketplaceDiscoveryInputSchema: ZodObject<{ q: ZodOptional; kinds: ZodOptional<ZodArray<ZodEnum<{ api: "api"; service_offer: "service_offer"; open_request: "open_request"; }>>>; network: ZodOptional<...>; cursor: ZodOptional<...>; limit... | 0.5.0 or earlier |
| marketplaceDiscoveryPageSchema | constant marketplaceDiscoveryPageSchema: ZodObject<{ protocol: ZodLiteral<"vapi.marketplace.discovery/1">; items: ZodArray<ZodUnion<readonly [ZodDiscriminatedUnion<[ZodObject<{ kind: ZodLiteral<"api">; provenance: ZodEnum<{ partner: "partner"; self_listed: ... | 0.5.0 or earlier |
| marketplaceExecutionMethodSchema | constant marketplaceExecutionMethodSchema: ZodEnum<{ GET: "GET"; HEAD: "HEAD"; POST: "POST"; PUT: "PUT"; PATCH: "PATCH"; DELETE: "DELETE"; }> | 0.5.0 or earlier |
| marketplaceHitSchema | constant marketplaceHitSchema: ZodUnion<readonly [ZodDiscriminatedUnion<[ZodObject<{ kind: ZodLiteral<"api">; provenance: ZodEnum<{ partner: "partner"; self_listed: "self_listed"; }>; execution: ZodObject<{ mode: ZodEnum<{ direct: "direct"; gateway: "gatewa... | 0.5.0 or earlier |
| marketplaceKindSchema | constant marketplaceKindSchema: ZodEnum<{ api: "api"; service_offer: "service_offer"; open_request: "open_request"; }> | 0.5.0 or earlier |
| marketplacePublicFactSchema | constant marketplacePublicFactSchema: ZodObject<{ label: ZodString; value: ZodString; }, $loose> | 0.5.0 or earlier |
| mergeListings | function (groups: Iterable<readonly Listing[]>): Listing[] | 0.5.0 or earlier |
| migrateLegacyRegistryConfig | function (path = getVapiPaths().config): Promise<LegacyRegistryRewrite[]> | 0.5.0 or earlier |
| migrateLegacyVapiHome | function (options: MigrationOptions = {}): Promise<string[]> | 0.5.0 or earlier |
| NETWORKS | constant NETWORKS: { readonly "eip155:8453": { readonly family: "evm"; readonly chainId: 8453; readonly name: "Base mainnet"; readonly usdc: 0x${string}; readonly gasToken: "ETH"; readonly rpcEnv: "BASE_RPC_URL"; readonly publicRpcUrl: "https: | 0.5.0 or earlier |
| noPassphraseHint | function (walletName: string): string | 0.5.0 or earlier |
| normalizeResourceUrl | function (value: string): string | 0.5.0 or earlier |
| ONRAMP_FALLBACK_INSTRUCTIONS | constant ONRAMP_FALLBACK_INSTRUCTIONS: "Send USDC on Base (eip155:8453) to this address; add a little ETH for gas if you plan to sweep." | 0.5.0 or earlier |
| ONRAMP_NETWORK | constant ONRAMP_NETWORK: "base" | 0.5.0 or earlier |
| openRequestMarketplaceHitSchema | constant openRequestMarketplaceHitSchema: ZodObject<{ kind: ZodLiteral<"open_request">; action: ZodObject<{ type: ZodLiteral<"propose_to_request">; href: ZodUnion<readonly [ZodString, ZodURL]>; }, $loose>; ... 7 more ...; card: ZodObject<...>; }, $loose> | 0.5.0 or earlier |
| parse402Challenge | function (challenge: unknown, configuredNetworks: X402NetworkConfig, fallbackResourceUrl = "", requiredNetwork?: string, expectedPayTo?: string): X402Quote | 0.5.0 or earlier |
| parse402Response | function (response: Response, configuredNetworks: X402NetworkConfig, requiredNetwork?: string, expectedPayTo?: string): Promise | 0.5.0 or earlier |
| parseDiscovery | function (raw: unknown): DiscoveryCatalog | 0.5.0 or earlier |
| parseEip155ChainId | function (network: string): number | 0.5.0 or earlier |
| parseReceipt | function (value: unknown): Receipt | 0.5.0 or earlier |
| parseSearchEvent | function (value: unknown): SearchEvent | 0.5.0 or earlier |
| parseSettlementResponse | function (headers: Headers): unknown | null | 0.5.0 or earlier |
| parseSIWxChallenge | function (paymentRequired: unknown, configuredNetworks: X402NetworkConfig, responseUrl: string | URL, requiredNetwork?: string): SIWxChallenge | null | 0.5.0 or earlier |
| parseSIWxResponse | function (response: Response, configuredNetworks: X402NetworkConfig, responseUrl: string | URL = response.url, requiredNetwork?: string): Promise<SIWxChallenge | null> | 0.5.0 or earlier |
| PASSPHRASE_ENVIRONMENT_VARIABLE | constant PASSPHRASE_ENVIRONMENT_VARIABLE: "VAPI_KEYSTORE_PASSWORD" | 0.5.0 or earlier |
| payRequest | function (args: PayRequestArgs): Promise | 0.5.0 or earlier |
| phraseToEntropy | function (phrase: string): Uint8Array | 0.5.0 or earlier |
| phraseToSeed | function (phrase: string): Uint8Array | 0.5.0 or earlier |
| pinnedLookup | function (lookup: LookupFn): LookupFunction | 0.5.0 or earlier |
| promptForSecret | function (prompt: string, noTerminalHint?: string): Promise | 0.5.0 or earlier |
| PROVENANCES | constant PROVENANCES: readonly ["indexed", "self_listed", "partner"] | 0.5.0 or earlier |
| provenanceSchema | constant provenanceSchema: ZodEnum<{ partner: "partner"; indexed: "indexed"; self_listed: "self_listed"; }> | 0.5.0 or earlier |
| readAgentProfile | function (home: string, name: string): Promise | 0.5.0 or earlier |
| readAuditLog | function (home: string): Promise<AuditEntry[]> | 0.5.0 or earlier |
| readKeystoreAddress | function (path = getVapiPaths().keystore): Promise<string | undefined> | 0.5.0 or earlier |
| readKeystoreVersion | function (path = getVapiPaths().keystore): Promise<number | undefined> | 0.5.0 or earlier |
| readReceipts | function (path = getVapiPaths().receipts, options: { limit?: number; wallet?: string } = {}): Promise<Receipt[]> | 0.3.0 |
| readDocs | function (pageUrlOrPath: string, options?: DocsRequestOptions): Promise | Unreleased |
| readSearchEvents | function (path = getVapiPaths().searches): Promise<SearchEvent[]> | 0.5.0 or earlier |
| readSolanaGasBalance | function (args: { network: string; configured: ConfiguredNetwork; address: string; } & SolanaRpcOptions): Promise | 0.5.0 or earlier |
| readSolanaUsdcBalance | function (args: { network: string; configured: ConfiguredNetwork; address: string; } & SolanaRpcOptions): Promise | 0.5.0 or earlier |
| readSpendLedger | function (path = getAgentCashPaths().ledger, now = new Date(), wallet: WalletName = DEFAULT_WALLET_NAME): Promise | 0.5.0 or earlier |
| readSpendLedgerRows | function (path = getAgentCashPaths().ledger, now = new Date()): Promise<SpendLedgerRow[]> | 0.5.0 or earlier |
| readUsdcBalance | function (args: { network: string; configured: AgentCashConfig["networks"][string]; address: string; allowPrivateNetwork?: boolean; fetchImpl?: typeof fetch; lookup?: LookupFn; }): Promise | 0.5.0 or earlier |
| receiptsToCsv | function (receipts: readonly Receipt[]): string | 0.5.0 or earlier |
| receiptWallet | function (receipt: Receipt): WalletName | 0.5.0 or earlier |
| removeAgentProfile | function (home: string, name: string): Promise | 0.5.0 or earlier |
| renameReceiptWallet | function (from: WalletName, to: WalletName, path = getVapiPaths().receipts): Promise | 0.5.0 or earlier |
| requireRpcUrl | function (network: string, configured: ConfiguredNetwork): string | 0.5.0 or earlier |
| reserveSpend | function (amountAtomic: bigint, caps: SpendCaps, options?: { ledgerPath?: string; now?: Date; wallet?: WalletName }): Promise | 0.5.0 or earlier |
| resolvePassphrase | function (walletName: string, options: ResolvePassphraseOptions = {}): Promise | 0.3.0 |
| resolveRegistryUrl | function (env: NodeJS.ProcessEnv = process.env): string | 0.5.0 or earlier |
| rewriteLegacyRegistryUrl | function (value: string): string | 0.5.0 or earlier |
| rewriteLegacyRegistryUrls | function (config: VapiConfig): { config: VapiConfig; changes: LegacyRegistryRewrite[]; } | 0.5.0 or earlier |
| ROUTER_TOPUP_TIERS | constant ROUTER_TOPUP_TIERS: readonly [1, 5, 20, 50] | 0.5.0 or earlier |
| searchServicesResponseSchema | constant searchServicesResponseSchema: ZodObject<{ services: ZodArray<ZodObject<{ verified: ZodBoolean; wrapped: ZodBoolean; price: ZodString; networks: ZodArray; endpoints: ZodArray<...>; ... 10 more ...; tier: ZodEnum<...>; }, $loose>>; }, $loose> | 0.5.0 or earlier |
| searchDocs | function (query: string, options?: DocsSearchOptions): Promise | Unreleased |
| SECRET_STORE_SERVICE | constant SECRET_STORE_SERVICE: "vapi-network" | 0.5.0 or earlier |
| secretsAllowed | function (env: NodeJS.ProcessEnv, streams: SecretsStreams): SecretsDecision | 0.5.0 or earlier |
| secretStore | function (options: SecretStoreOptions = {}): SecretStore | 0.5.0 or earlier |
| serviceOfferMarketplaceHitSchema | constant serviceOfferMarketplaceHitSchema: ZodObject<{ kind: ZodLiteral<"service_offer">; action: ZodObject<{ type: ZodLiteral<"start_engagement">; href: ZodUnion<readonly [ZodString, ZodURL]>; }, $loose>; ... 7 more ...; card: ZodObject<...>; }, $loose> | 0.5.0 or earlier |
| serviceSummarySchema | constant serviceSummarySchema: ZodObject<{ verified: ZodBoolean; wrapped: ZodBoolean; price: ZodString; networks: ZodArray; endpoints: ZodArray<ZodObject<{ name: ZodString; ... 10 more ...; payment: ZodOptional<...>; }, $loose>>; ... 10 more ...;... | 0.5.0 or earlier |
| serviceTierSchema | constant serviceTierSchema: ZodEnum<{ listed: "listed"; verified: "verified"; partner: "partner"; }> | 0.5.0 or earlier |
| SIGN_IN_WITH_X | constant SIGN_IN_WITH_X: "sign-in-with-x" | 0.5.0 or earlier |
| SIWxError | class SIWxError | 0.5.0 or earlier |
| SOLANA_DERIVATION_PATH | constant SOLANA_DERIVATION_PATH: "m/44'/501'/0'/0'"
