Catalog

Describe one selected tool

Returns the full input schema, example, response contract, pricing, and next action for one principal-visible search result. Secret keys require tenant:read. This operation does not call a provider or burn credits.

post/credits/tools/describe

Request

  • Base URL
    https://api.paywithlocus.com/api
  • URL
    https://api.paywithlocus.com/api/credits/tools/describe
  • 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
operation_querystring

Original search intent used to select the most relevant operation from a directory endpoint.

Response

Full selected tool contract

successunknown required
toolobject required

Changes

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