Catalog

Quote one described tool

Prices the intended request without dispatching it or burning credits. Variable-price and live external-rail tools may return an executable approval token or request a hard maximum before execution.

post/credits/tools/estimate

Request

  • Base URL
    https://api.paywithlocus.com/api
  • URL
    https://api.paywithlocus.com/api/credits/tools/estimate
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP bearer
    • or HTTP bearer

Headers

X-Locus-Session-Idstring

Required only when the end-user JWT carries sid. Send the original high-entropy session value; sid is its SHA-256 fingerprint. Ignored for secret-key authentication.

X-Locus-End-Userstring

Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.

Optional end-user identity for a tenant secret key.

Request body

slugstring required
bodyobject
max_charge_creditsstring

Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.

preflight_external_quoteboolean
idempotency_keystring
expires_in_secondsinteger

Response

No-dispatch price estimate or executable quote

successunknown required
estimateobject required

Changes

No recorded changes to this operation across all 1 revision of this API.