API Keys, Documentation & AI Agent Access
Generate REST API Keys & Secrets for external apps and AI agents, copy ready-to-share connection guides, or test live endpoints directly.
REST API Key & Secret Authentication
Generate an API Key & Secret in the API Keys & Secrets tab, then pass both headers on requests from any external app, webhook, or AI agent.
Step 1 · Generate Key in Dashboard
Open the API Keys & Secrets tab (in Site Settings → API & AI Agents), create a key for your external app, and copy the generated Key + Secret bundle.
Step 2 · Send Request Headers
Step 3 · Call Any Endpoint
POST JSON payloads to https://ridecluster.com/functions/<endpoint>. Choose Full Access or Read-Only per key and revoke or rotate secrets anytime.
Feature & Data REST Endpoints
/functions/marketplaceApiUnified REST API endpoint for vehicle search, details + reviews, 2–4 car comparisons, loan/lease/5-year TCO calculations, trade-in valuation, price prediction, market insights, lead submission, appointment booking, and direct entity CRUD.
curl -X POST "https://ridecluster.com/functions/marketplaceApi" \
-H "X-API-Key: rc_live_YOUR_API_KEY" \
-H "X-API-Secret: rcs_secret_YOUR_API_SECRET" \
-H "Content-Type: application/json" \
-d '{"action":"search_vehicles","make":"Honda","max_price":30000,"limit":5}'/functions/decodeVINDecodes any 17-character VIN via NHTSA to return make, model, year, body class, fuel type, transmission, and drivetrain.
curl -X POST "https://ridecluster.com/functions/decodeVIN" \
-H "X-API-Key: rc_live_YOUR_API_KEY" \
-H "X-API-Secret: rcs_secret_YOUR_API_SECRET" \
-H "Content-Type: application/json" \
-d '{"vin":"5YJ3E1EA7KF317000"}'/functions/getVehicleHistoryFetches ownership, accident, odometer, and blockchain verification records for a VIN.
curl -X POST "https://ridecluster.com/functions/getVehicleHistory" \
-H "X-API-Key: rc_live_YOUR_API_KEY" \
-H "X-API-Secret: rcs_secret_YOUR_API_SECRET" \
-H "Content-Type: application/json" \
-d '{"vin":"5YJ3E1EA7KF317000","provider":"carfax"}'/functions/analyzeInventoryRuns AI demand forecasting and pricing optimization on a single listing (analyze_single) or full portfolio (analyze_portfolio).
curl -X POST "https://ridecluster.com/functions/analyzeInventory" \
-H "X-API-Key: rc_live_YOUR_API_KEY" \
-H "X-API-Secret: rcs_secret_YOUR_API_SECRET" \
-H "Content-Type: application/json" \
-d '{"action":"analyze_portfolio"}'/functions/qualifyLeadScores a buyer lead with AI, estimating conversion probability, urgency tier, and next best action.
curl -X POST "https://ridecluster.com/functions/qualifyLead" \
-H "X-API-Key: rc_live_YOUR_API_KEY" \
-H "X-API-Secret: rcs_secret_YOUR_API_SECRET" \
-H "Content-Type: application/json" \
-d '{"lead_id":"LEAD_ID","auto_execute":false}'/functions/nurtureLeadRuns lead scoring, optimal contact timing, AI email/SMS response drafting, sentiment analysis, behavior triggers, or automated sequences.
curl -X POST "https://ridecluster.com/functions/nurtureLead" \
-H "X-API-Key: rc_live_YOUR_API_KEY" \
-H "X-API-Secret: rcs_secret_YOUR_API_SECRET" \
-H "Content-Type: application/json" \
-d '{"lead_id":"LEAD_ID","action":"draft_response"}'/functions/getDealerAvailabilityReturns open test-drive and consultation time slots for a dealer over the upcoming days.
curl -X POST "https://ridecluster.com/functions/getDealerAvailability" \
-H "X-API-Key: rc_live_YOUR_API_KEY" \
-H "X-API-Secret: rcs_secret_YOUR_API_SECRET" \
-H "Content-Type: application/json" \
-d '{"dealerEmail":"dealer@example.com","daysAhead":7}'/functions/initiateVapiCallPlaces an outbound Vapi AI voice call to qualify a lead and book an appointment.
curl -X POST "https://ridecluster.com/functions/initiateVapiCall" \
-H "X-API-Key: rc_live_YOUR_API_KEY" \
-H "X-API-Secret: rcs_secret_YOUR_API_SECRET" \
-H "Content-Type: application/json" \
-d '{"leadId":"LEAD_ID","customerName":"Alex Rivera","customerPhone":"+15550192834","carTitle":"2022 Tesla Model 3","dealerEmail":"dealer@example.com","dealerName":"Premier Motors"}'/functions/pushLeadToCRMPushes a RideCluster lead record into a configured external CRM integration.
curl -X POST "https://ridecluster.com/functions/pushLeadToCRM" \
-H "X-API-Key: rc_live_YOUR_API_KEY" \
-H "X-API-Secret: rcs_secret_YOUR_API_SECRET" \
-H "Content-Type: application/json" \
-d '{"lead_id":"LEAD_ID","integration_id":"INTEGRATION_ID"}'/functions/syncDMSInventorySynchronizes vehicle listings from a dealer's REST API, XML, or JSON DMS feed.
curl -X POST "https://ridecluster.com/functions/syncDMSInventory" \
-H "X-API-Key: rc_live_YOUR_API_KEY" \
-H "X-API-Secret: rcs_secret_YOUR_API_SECRET" \
-H "Content-Type: application/json" \
-d '{"integration_id":"INTEGRATION_ID"}'/functions/manageUserPrivilegesAdmin endpoint to list users or update roles and individual feature privilege checkboxes.
curl -X POST "https://ridecluster.com/functions/manageUserPrivileges" \
-H "X-API-Key: rc_live_YOUR_API_KEY" \
-H "X-API-Secret: rcs_secret_YOUR_API_SECRET" \
-H "Content-Type: application/json" \
-d '{"action":"list_users"}'Supported Data Entities
Query, read, create, update, or delete records in any entity below via POST /functions/marketplaceApi using actions entity_query, entity_get, entity_create, entity_update, and entity_delete with your X-API-Key and X-API-Secret headers:
In-App Conversational Agents
External AI systems can also connect via the MCP tab (/api/mcp) to converse directly with RideCluster's built-in agents:
dream_car_finderConversational vehicle concierge that recommends inventory, compares specs, and answers buyer questions.
social_media_managerAutomotive marketing agent for generating social campaigns, ad copy, and promotional content.