Authentication
Create an agent API key in the Locus dashboard. Use it as a Bearer token when quoting, calling a tool, or retrieving a result. Catalog discovery is public.Discover registered tools
Fetch the catalog for one provider:Discover Firecrawl tools
provider to list all tools. The response includes exact provider/endpoint slugs in data.endpoints and display metadata in data.catalog.
The provider reference supplies request fields, examples, and estimated pricing. See the catalog for every provider’s reference.
Quote a call
Send your intended request to its/quote route. This checks the inputs and price without calling the provider:
Quote a scrape request
data.price_usdc or X-Locus-Cost-Usd. Calls have a $0.001 minimum. A provider’s free endpoint can still carry a Locus fee.
Make a call
Send the same body to the tool route. Use a uniqueIdempotency-Key for each logical call and reuse it for retries. To lock the quoted price, set X-Locus-Expected-Cost-Usd to the value you just received.
Run the quoted request
data. A changed price returns 409 PRICE_CHANGED before the provider is called.
Approval flow
Calls above your approval threshold return202 with an approval_url and result_path.
- Open or share the approval URL.
- After approval, Locus executes the stored request.
- Fetch
result_pathwith the same Bearer key, or retry the identical request with its originalIdempotency-Key.
Enable and disable tools
Open Services → Agent tools in the dashboard. Locus-managed tools start enabled; provider and tool toggles restrict access immediately.Error handling
X-Locus-Retry-Safe: true confirms that no provider request was dispatched. Without that confirmation, a failed response can still represent work the provider accepted. Preserve the original idempotency key for any same-route retry.
For full request contracts and provider-specific errors, use the generated references in the tool catalog.