Authentication failed to load

The authentication service is taking too long to load. This is usually caused by a network block (VPN/firewall), browser extensions (ad blockers), or temporary connectivity issues.

    Developer API
    Pro / Enterprise

    SpareFinder API Documentation

    Integrate SpareFinder with ERP/CMMS tools using secure API keys.

    Authentication

    Use the x-api-key header. Keys are shown once at creation—store them securely.

    x-api-key: <YOUR_API_KEY>

    Plan rules & limits

    • Pro: API access enabled, monthly API call cap enforced.
    • Enterprise: API access enabled, unlimited API calls.
    • All API calls count toward your monthly usage tracking.

    Endpoints

    GET
    /api/external/v1/me

    Returns subscription tier, limits, and current month usage for the key owner.

    curl -X GET "https://aiagent-sparefinder-org.onrender.com/api/external/v1/me" \
      -H "x-api-key: <YOUR_API_KEY>"
    POST
    /api/external/v1/search/keywords/schedule
    costs 1 credit

    Schedule a keyword search job through the AI crew pipeline.

    curl -X POST "https://aiagent-sparefinder-org.onrender.com/api/external/v1/search/keywords/schedule" \
      -H "Content-Type: application/json" \
      -H "x-api-key: <YOUR_API_KEY>" \
      -d '{"keywords":["bearing","SKF 6205","deep groove"]}'
    GET
    /api/external/v1/search/keywords/status/:jobId

    Poll job status/results by jobId returned from schedule.

    curl -X GET "https://aiagent-sparefinder-org.onrender.com/api/external/v1/search/keywords/status/<JOB_ID>" \
      -H "x-api-key: <YOUR_API_KEY>"

    Common errors

    • 401 api_key_invalid: key missing/invalid/revoked.
    • 403 api_access_not_enabled: your plan doesn’t include API access.
    • 429 api_limit_exceeded: Pro monthly API call cap reached.
    • 402 insufficient_credits: you ran out of credits for keyword scheduling.

    API Access is Locked

    Integrate SpareFinder with your ERP/CMMS tools using secure API keys. Available in Professional and Enterprise plans.

    Professional Plan Required

    Unlock this feature and more with a Professional subscription