🚗 Getaround — Documentation de l'API Pricing

Documentation de l'API accessible via /docs. Cette API expose un modèle de Machine Learning qui prédit rental_price_per_day en fonction des caractéristiques du véhicule.

Vue d'ensemble

• GET / — Page d'accueil (HTML)
• GET /health — Healthcheck (JSON)
• POST /predict — Prédiction (JSON)
• GET /docs — Documentation (HTML)

GET /

curl -s https://anabeldg-getaround-pricing-api.hf.space/

GET /health

curl -s https://anabeldg-getaround-pricing-api.hf.space/health

Réponse attendue :

{
  "status": "ok"
}

GET /docs

curl -s https://anabeldg-getaround-pricing-api.hf.space/docs

POST /predict

• Méthode : POST
• Entrée : JSON avec une clé input
• Sortie : JSON {"prediction": [...]} (une prédiction par ligne)

Formats acceptés

• Format matrice (requis pour l'évaluation) : {"input": [[...], [...]]}
• Format dictionnaires (optionnel / compatibilité) : {"input": [{"feature": value, ...}]}

1) Format matrice (requis)

Chaque ligne doit contenir exactement 13 valeurs, dans l'ordre strict suivant (défini par feature_order.json) :

model_key, mileage, engine_power, fuel, paint_color, car_type,
private_parking_available, has_gps, has_air_conditioning, automatic_car,
has_getaround_connect, has_speed_regulator, winter_tires

Types attendus :

• model_key, fuel, paint_color, car_type → chaînes de caractères
• mileage, engine_power → valeurs numériques
• Variables booléennes → true/false ou 0/1

Si une ligne n'a pas 13 valeurs, l'API renvoie une erreur 422.

Exemple de requête (matrice) :

{
  "input": [
    ["Citroën", 140411, 100, "diesel", "black", "convertible", 1, 1, 0, 0, 1, 1, 1]
  ]
}

curl :

curl -X POST "https://anabeldg-getaround-pricing-api.hf.space/predict" \
-H "Content-Type: application/json" \
-d '{"input":[["Citroën",140411,100,"diesel","black","convertible",1,1,0,0,1,1,1]]}'

Python :

import requests

payload = {
  "input": [
    ["Citroën", 140411, 100, "diesel", "black", "convertible", 1, 1, 0, 0, 1, 1, 1]
  ]
}

r = requests.post("https://anabeldg-getaround-pricing-api.hf.space/predict", json=payload)
print(r.json())
# {"prediction": [106.57]}

2) Format dictionnaires (compatibilité)

Ce format est accepté pour des raisons de compatibilité. Toutes les colonnes attendues doivent être présentes ; l'API réordonne ensuite selon FEATURE_ORDER.

Exemple de requête (dictionnaires) :

{
  "input": [
    {
      "model_key": "Citroën",
      "mileage": 140411,
      "engine_power": 100,
      "fuel": "diesel",
      "paint_color": "black",
      "car_type": "convertible",
      "private_parking_available": true,
      "has_gps": true,
      "has_air_conditioning": false,
      "automatic_car": false,
      "has_getaround_connect": true,
      "has_speed_regulator": true,
      "winter_tires": true
    }
  ]
}

Réponse

Une prédiction par ligne.

{
  "prediction": [106.57]
}

Erreurs possibles

• 422 — entrée invalide (mauvaise dimension de matrice, colonnes manquantes, JSON invalide)
• 500 — erreur interne lors de la prédiction (échec du modèle)