API Documentation

Introduction

the ModList API allows you to generate customized car modification plans based on specific vehicle details, budget constraints, and personal goals. The API uses the ModList AI to create detailed recommendations tailored to your needs.

Note: You need to be logged in and have an active subscription to use the API. Log in or sign up to get started.

Authentication

All API requests require authentication using an API token. You can create and manage your API tokens in your dashboard.

To authenticate your requests, include your API token in the X-API-Key header.

X-API-Key: YOUR API TOKEN

Endpoints

Generate Modification Plan

POST /api/v1/generate

Request Body

The request body should be a JSON object with the following structure:

{
  "prompt": JSON.stringify({
    "car": {
      "year": "2018",
      "make": "Honda",
      "model": "Civic"
    },
    "budget": {
      "amount": "5000",
      "type": "total"  // can be "total", "monthly", or "yearly"
    },
    "goals": "I want to improve performance and add some visual upgrades."
  })
}

Response

The API returns a JSON object with the following structure:

{
  "success": true,
  "response": "# Car Modification Plan for 2018 Honda Civic\n\n## Budget: $5,000 (Total)\n\nBased on your goals of improving performance and adding visual upgrades to your 2018 Honda Civic with a $5,000 budget, here's a comprehensive modification plan:\n\n## Performance Upgrades\n\n### Cold Air Intake - $300-350\n* K&N Typhoon or Injen SP Series\n* Adds 5-8 horsepower\n* Improves throttle response\n* Enhanced engine sound\n\n### Cat-Back Exhaust System - $700-900\n* Borla, Magnaflow, or HKS\n* 8-12 horsepower gain\n* Deeper, sportier exhaust note\n* Improved exhaust flow\n\n### Performance Tune - $500-700\n* Hondata FlashPro or KTuner\n* 15-25 horsepower gain\n* Improved throttle response\n* Custom mapping options\n\n### Suspension Upgrades - $800-1,000\n* Eibach Pro-Kit or H&R Sport Springs\n* Improved handling and reduced body roll\n* Moderate 1-1.5 inch drop for better stance\n* Pair with quality shocks for best results\n\n## Visual Upgrades\n\n### Wheels and Tires - $1,200-1,500\n* 18" Enkei, Konig, or Rays wheels\n* Performance tires (Michelin Pilot Sport 4 or Continental ExtremeContact)\n* Improved grip and appearance\n\n### Exterior Styling - $500-700\n* Front lip spoiler\n* Side skirts\n* Rear diffuser or spats\n* Small trunk spoiler\n\n### Window Tint - $250-350\n* 35% tint for side windows\n* 50% for windshield (if legal in your area)\n* Improved appearance and interior comfort\n\n### Interior Upgrades - $200-300\n* Shift knob upgrade\n* Carbon fiber trim pieces\n* LED interior lighting\n* Custom floor mats\n\n## Installation Costs\n* DIY some items to save money\n* Professional installation for exhaust and tune: ~$300-400\n\n## Total Estimated Cost: $4,450-5,800\n\n### Recommended Installation Order:\n1. Performance tune and intake (foundation for power)\n2. Exhaust system\n3. Suspension components\n4. Wheels and tires\n5. Exterior styling components\n6. Interior and finishing touches\n\nThis plan balances performance and visual upgrades while staying close to your $5,000 budget. The performance modifications should give you approximately 30-45 additional horsepower and noticeably improved handling, while the visual upgrades will give your Civic a more aggressive and personalized appearance."
}

Error Responses

The API may return the following error responses:

Status CodeDescription
400Bad Request - Missing required fields
401Unauthorized - Invalid API token
403Forbidden - API token is inactive or no subscription
500Internal Server Error

Code Examples

cURL
curl -X POST https://www.themodlist.com/api/v1/generate \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR API TOKEN" \
  -d '{"prompt":"{\"car\":{\"year\":\"2018\",\"make\":\"Honda\",\"model\":\"Civic\"},\"budget\":{\"amount\":\"5000\",\"type\":\"total\"},\"goals\":\"I want to improve performance and add some visual upgrades.\"}"}'