quote_service

io.github.nevermined-io/catalog · Verify this server

Price ONE call to a catalog service WITHOUT paying it: it charges nothing, signs nothing and reserves no budget. Pass exactly what you would pass to `pay_service` (the same `slug`, `path`, `method`, `search`, `headers`, `body` and `delegationId`): the Router sends that request to the service unpaid, reads the price it asks for, and returns an opaque `quoteId`, its short `expiresAt`, the rail (`protocol`), the network and merchant amount (`settlement`) and the fee-inclusive total (`fee.capChargedCents`, whole cents rounded up; `fee.capChargedMicros` exact, in 1/10,000 of a cent). Unlike the `quote` on a get_service endpoint (the last merchant price the catalog observed, routing fee excluded), this is priced live for your exact request and includes the fee. Because the request really reaches the service, a service that does not charge for it performs it, so take care quoting a method with side effects; and a quote spends the same per-service rate limit as a payment, so quote once per decision rather than polling. It prices the delegation pay_service would charge (`optionSet: "delegation"`, naming its `delegationId`), or, with no delegation set up, what a personal crypto delegation would select (`optionSet: "deployment"`); in that case `nextTool` is `setup_delegation`: set one up and quote again before paying, since the delegation you create can select a different rail and price. It checks neither your remaining budget nor your wallet balance (see get_budget and wallet_balance). Next step (`nextTool: "pay_service"`): if `fee.capChargedCents` fits what you planned to spend, call `pay_service` before expiry with the same arguments, the quoted `delegationId`, `quoteId`, and `maxTotalCents` set to that figure as a number. The quote id fixes the exact challenge and fee-inclusive total while `maxTotalCents` remains an independent ceiling. `paymentRequired: false` means the service did not ask for payment for this request; `upstreamStatus` is its answer, and a non-2xx usually means the path, method or body is wrong. The service response itself is never returned. Outcomes, all charging nothing: `{"payable":false}`, `service_not_found`, `catalog_unavailable` and `delegation_lookup_failed` as in pay_service; `quote_unavailable` (no quote can be made here and retrying will not change that, so bound the price with pay_service `maxTotalCents` instead); `quote_failed` (the Router refused to price the call, or did not answer; see `code`, `message` and `retryable`); `credential_refused` (re-authorize). FUNDING (`funding`): chosen as pay_service would choose it. When you hold an active Nevermined Subscription and the endpoint carries a subscription tariff the answer is `{"funding":"subscription","credits":…,"tariffVersion":…}`: the credits one call costs from the published tariff (the service is not contacted, and there is no `quoteId` or cent total); then call pay_service with the same arguments. The credits left in your monthly allowance and the price ceiling are checked only when pay_service makes the call, so this answer does not promise the call will be paid with credits. Pass `funding: "delegation"` to price the delegation instead. Subscription refusals are named as in pay_service. Requires your Nevermined API key on the Authorization header.