← Back to Lucky Rentals

Lucky Rentals AI Agent API

API for discovering vehicle availability and pricing for the Lucky Rentals booking system.

📖 Interactive Documentation

Try the API in your browser with Swagger UI. Test endpoints and see responses in real-time.

📄 OpenAPI Specification

View the raw OpenAPI 3.0.3 specification in YAML format.

Getting Started

Base URL

https://luckyrentals.co.nz/api/agent

Authentication

Currently, the API is publicly accessible. No authentication required for read-only operations.

Rate Limits

100 requests per 60 seconds per IP address.

Rate limit headers are included in responses: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

API Workflow

  1. 1

    Discover Depots

    GET /api/agent/depots

    Get available pickup/dropoff locations

  2. 2

    Check Availability

    GET /api/agent/vehicles/availability

    Find available vehicles for specific dates and locations

  3. 3

    Discover Options

    GET /api/agent/vehicles/{vehicleId}/accessories
    GET /api/agent/vehicles/{vehicleId}/insurance-types

    Get available accessories and insurance options

  4. 4

    Get Quote

    GET /api/agent/quotes

    Generate final pricing with selected options

Example Request

Get Available Depots

curl -X GET "https://luckyrentals.co.nz/api/agent/depots" \
  -H "Accept: application/json"

Response

[
  {
    "id": 1,
    "name": "Auckland Airport",
    "pickup_times": [...],
    "drop_off_times": [...],
    "opening_hours_description": "Weekdays 9am-5pm"
  }
]

Additional Resources

Questions or issues? Contact info@luckyrentals.co.nz