JOYRYDE API

Accepts a plain English question and returns structured JSON with the answer or a pointer to the right endpoint. This is the primary entry point for AI agents that haven't learned the API schema yet.

{
  "query": "What vehicles do you have for long-term rental?"
}

{
  "received_query": "What vehicles do you have for long-term rental?",
  "status": "nl_processing_not_yet_implemented",
  "suggestion": "Use structured endpoints directly",
  "available_endpoints": {
    "vehicles": "GET /api/vehicles",
    "availability": "GET /api/availability?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD",
    "booking": "POST /api/bookings"
  },
  "docs": "https://joy-ryde.com/api-docs"
}

Returns current service status, version, and environment. Use this to verify the API is online before making other calls.

{
  "status": "ok",
  "service": "Joyryde API",
  "version": "1.0.0",
  "environment": "production",
  "timestamp": "2026-03-09T12:00:00.000Z"
}

Returns all vehicle categories with real-time availability counts from the live fleet inventory. Use the type query parameter to filter by rental type.

{
  "vehicles": [
    {
      "name": "Economy Sedan",
      "slug": "economy-sedan",
      "image": "/Vehicles/compact.png",
      "description": "Fuel-efficient sedans perfect for rideshare driving",
      "rental_types": ["short-term", "long-term"],
      "available_count": 12
    }
  ],
  "total_listed": 44,
  "source": "google_sheets",
  "rental_type_filter": "all"
}

Returns detailed information for a single vehicle category.

Creates a new rental booking. Returns a reference number (e.g., JR-123456) for tracking.

{
  "success": true,
  "refNumber": "JR-849201",
  "bookingId": 42,
  "status": "pending"
}

Returns a paginated list of all bookings. Supports filtering by status and type.

Look up a specific booking by its Joyryde reference number (e.g., JR-123456).

Update the status of an existing booking.

Creates a Stripe checkout session for long-term rental enrollment. Collects an $849 protection fee and saves the card for weekly subscription billing.

{
  "success": true,
  "refNumber": "JR-849201",
  "checkoutUrl": "https://checkout.stripe.com/c/pay/...",
  "sessionId": "cs_live_..."
}

Creates a Stripe payment intent for a short-term rental. Collects 20% as a reservation deposit; the remaining 80% is collected at check-in.

{
  "success": true,
  "refNumber": "JR-849201",
  "clientSecret": "pi_...secret_...",
  "reservationAmount": "59.80",
  "totalAmount": "299.00",
  "remainingAmount": "239.20"
}

Verify that a booking's payment completed successfully. Called after Stripe redirect.

Captures a lead with automatic scoring. The lead enters a nurture sequence based on their contact preference.

{
  "success": true,
  "leadId": 17
}

Unsubscribe an email address from the newsletter using a CAN-SPAM compliant token.

Re-subscribe a previously unsubscribed email using their token.

Send a conversation to the AI advisor. It specializes in comparing car ownership/lease costs against renting, with a focus on total cost of ownership for gig economy drivers.

{
  "messages": [
    { "role": "user", "content": "I drive Uber 40 hours a week. Is it cheaper to rent or buy?" }
  ]
}

{
  "content": "Great question! Let's break down the numbers...",
  "usage": {
    "input_tokens": 142,
    "output_tokens": 387
  }
}

Validates a check-in token and returns booking state. Used to initialize the check-in portal.

Upload a photo as part of the check-in process. Accepts driver's license (front/back), selfie, and vehicle condition photos. Max 10MB, JPEG/PNG/HEIC. Rate limited to 20 uploads per token.

Places an authorization hold on the customer's saved card for the remaining 80% balance. Requires identity verification to be complete first. Hold is captured when vehicle photos are submitted.

Verifies all 4 vehicle condition photos are uploaded, captures the payment hold, and returns the lockbox code. This is the only endpoint that reveals the lockbox code.

Returns current check-in progress including which photos have been uploaded and payment authorization state. Query param: ?token=xxx