CARgument AI API
Our flexible and powerful API for integrating AI capabilities into your automotive platform.
API Documentation
Our API is very flexible and designed to be easy to integrate with your existing systems.
Overview
The CARgument AI API provides access to our powerful AI capabilities for automotive data processing, content generation, and recommendation systems. Our RESTful API allows you to integrate these features directly into your platform.
Fast & Reliable
99.9% uptime with global CDN distribution for low-latency responses.
Secure
Enterprise-grade security with TLS encryption and OAuth 2.0 authentication.
Authentication
All API requests require authentication using an API key. You can obtain an API key by contacting our sales team.
API Key Authentication
curl -X GET "https://api.cargument.ai/v1/vehicles" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"Endpoints
Our API provides the following main endpoints:
List Vehicles
Returns a list of vehicles based on the provided filters.
Query Parameters:
- make: string
- model: string
- year: number
- limit: number (default: 20)
- offset: number (default: 0)
Generate Content
Generates AI-powered content for vehicle descriptions, comparisons, or features.
Request Body:
- vehicleId: string
- contentType: string (description, comparison, features)
- targetLength: number (optional)
- compareWith: string[] (optional, for comparison type)
Get Recommendations
Returns personalized vehicle recommendations based on user preferences or vehicle ID.
Request Body:
- userId: string (optional)
- vehicleId: string (optional)
- recommendationType: string (similar, upsell, crossmarket)
- limit: number (default: 5)
Examples
Here are some examples of how to use our API:
Generate Vehicle Description
Request
curl -X POST "https://api.cargument.ai/v1/content/generate" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"vehicleId": "v123456",
"contentType": "description",
"targetLength": 200
}'Response
{
"id": "content_123",
"vehicleId": "v123456",
"contentType": "description",
"content": "The 2023 Toyota RAV4 combines versatility with modern design. This compact SUV offers excellent fuel efficiency with its 2.5L 4-cylinder engine, delivering up to 35 MPG highway. The spacious interior comfortably seats five passengers with ample cargo space. Standard safety features include Toyota Safety Sense 2.0 with pre-collision system, lane departure alert, and adaptive cruise control. Available in multiple trim levels to suit various preferences and budgets.",
"metadata": {
"wordCount": 65,
"characterCount": 389,
"generatedAt": "2023-06-15T14:22:33Z"
}
}SDKs & Libraries
We provide official client libraries for popular programming languages to make integration easier:
JavaScript/TypeScript
Official Node.js client for CARgument AI API.
npm install cargument-ai-sdk
Python
Official Python client for CARgument AI API.
pip install cargument-ai
Ready to integrate with our API?
Contact our team to get API access and start building with CARgument AI.