Vinni API Documentation¶

Overview¶

Vinni.ai provides a suite of powerful APIs for automotive document processing and vehicle analysis. These APIs leverage advanced image processing, computer vision, and AI-powered data extraction to provide comprehensive vehicle data and document analysis.

Available APIs¶

Analyze Docs: Process vehicle title documents and extract detailed information.
Analyze Vehicle: Analyze vehicle images, extract details, and perform damage assessment.
Verification: Verify information on vehicle title documents against provided data.
History: Retrieve comprehensive vehicle history based on the VIN.

Getting Started¶

This guide will help you get up and running with the Vinni APIs quickly and efficiently.

To use the Vinni APIs, you'll need to sign up for an API key

2. Authentication¶

All Vinni APIs use Bearer token authentication. Include your API key in the authorizationToken header of each request:

3. Making Your First API Call¶

Let's make a simple API call to the History endpoint to retrieve a vehicle's history:

import requests
import json

# Replace with your actual API key
api_key = "YOUR_API_KEY_HERE"

# API endpoint
url = "https://api.vinni.ai/v1/history"

# Request headers
headers = {
    "Content-Type": "application/json",
    "authorizationToken": f"{api_key}"
}

# Request body
data = {
    "vin": "EXAMPLE_VIN_HERE"
}

# Make the API call
response = requests.post(url, headers=headers, json=data)

# Check the response
if response.status_code == 200:
    result = response.json()
    print(json.dumps(result, indent=2))
else:
    print(f"Error: {response.status_code}")
    print(response.text)

Replace "YOUR_API_KEY_HERE" with your actual API key and "EXAMPLE_VIN_HERE" with a valid VIN to test the API.

4. Understanding API Responses¶

All Vinni APIs return responses in JSON format. A typical successful response will have the following structure:

{
  "code": 200,
  "message": "Success",
  "responseData": {
    // API-specific response data
  }
}

In case of errors, you'll receive an appropriate error code and message:

{
  "code": 400,
  "message": "Invalid input or missing required fields"
}

5. API Versioning¶

Vinni uses semantic versioning for its APIs. The current version is v1. Always specify the version in your API calls to ensure compatibility:

https://api.vinni.ai/v1/endpoint

Next Steps¶

Now that you're familiar with the basics of the Vinni APIs, explore the detailed documentation for each API to learn about their specific capabilities and parameters

Happy coding with Vinni APIs!