> ## Documentation Index
> Fetch the complete documentation index at: https://docs.steerai.autos/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> Complete REST API documentation for Steer AI's vehicle inspection and pricing platform

## Welcome to Steer AI API

The Steer AI API provides programmatic access to our AI-powered vehicle inspection, pricing, and CRM platform. Build custom integrations, automate workflows, and create powerful automotive applications.

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/getting-started/quickstart">
    Get your API keys and make your first request in minutes
  </Card>

  <Card title="Authentication" icon="key" href="/getting-started/authentication">
    Secure your API requests with proper authentication
  </Card>

  <Card title="Integration Guide" icon="plug" href="/integration/api/overview">
    Complete guide to API integration and best practices
  </Card>

  <Card title="Best Practices" icon="star" href="/guides/best-practices">
    Security, performance, and optimization guidelines
  </Card>
</CardGroup>

## Base URL

All API endpoints are relative to the base URL:

**Production:** `https://api.steerai.autos/v1`

**Sandbox:** `https://api-sandbox.steerai.autos/v1`

## Authentication

All API requests require authentication using Bearer tokens:

```bash theme={null}
curl -X GET "https://api.steerai.autos/v1/inspections" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
```

<Warning>
  **Security Note:** Never expose your API keys in client-side code. Always use server-side implementations for production applications.
</Warning>

## Request/Response Format

### Request Headers

All requests should include these headers:

```http theme={null}
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
User-Agent: YourApp/1.0
```

### Response Format

All API responses follow this consistent structure:

```json theme={null}
{
  "status": "success",
  "data": {
    // Response data here
  },
  "meta": {
    "request_id": "req_1234567890abcdef",
    "timestamp": "2024-01-15T10:30:00Z",
    "processing_time": 1.234,
    "rate_limit": {
      "limit": 1000,
      "remaining": 999,
      "reset": 1640995200
    }
  }
}
```

## Core API Endpoints

<CardGroup cols={3}>
  <Card title="Vehicle Inspection" icon="search" href="/features/inspection/overview">
    Submit vehicles for AI-powered inspection and damage analysis
  </Card>

  <Card title="Pricing & Valuation" icon="dollar-sign" href="/features/pricing/overview">
    Get real-time market valuations and damage impact calculations
  </Card>

  <Card title="CRM Management" icon="users" href="/features/crm/overview">
    Manage leads, customers, and inventory through our CRM APIs
  </Card>
</CardGroup>

## Rate Limits

Rate limits are enforced per API key and vary by plan:

| Plan             | Requests/Hour | Concurrent | Burst Limit |
| ---------------- | ------------- | ---------- | ----------- |
| **Free**         | 1,000         | 5          | 50          |
| **Starter**      | 10,000        | 20         | 200         |
| **Professional** | 100,000       | 100        | 1,000       |
| **Enterprise**   | Unlimited     | Custom     | Custom      |

## SDKs and Libraries

<CardGroup cols={2}>
  <Card title="Python SDK" icon="python">
    ```bash theme={null}
    pip install steer-ai
    ```

    Full-featured Python library with async support
  </Card>

  <Card title="JavaScript SDK" icon="js">
    ```bash theme={null}
    npm install @steerai/sdk
    ```

    TypeScript-ready SDK for Node.js and browsers
  </Card>
</CardGroup>

## Example Requests

### Vehicle Inspection

```bash theme={null}
curl -X POST "https://api.steerai.autos/v1/inspections" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vehicle": {
      "vin": "1HGBH41JXMN109186",
      "make": "Honda",
      "model": "Civic",
      "year": 2021
    },
    "inspection_type": "full"
  }'
```

### Pricing Valuation

```bash theme={null}
curl -X POST "https://api.steerai.autos/v1/pricing/valuate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vehicle_id": "veh_1234567890",
    "mileage": 50000,
    "condition": "good"
  }'
```

### CRM Lead Creation

```bash theme={null}
curl -X POST "https://api.steerai.autos/v1/crm/leads" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+1234567890",
    "source": "website"
  }'
```

## Error Handling

All API responses follow a consistent error format:

```json theme={null}
{
  "status": "error",
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid VIN format",
    "type": "validation_error",
    "field": "vehicle.vin"
  },
  "meta": {
    "request_id": "req_1234567890abcdef"
  }
}
```

### Common Error Codes

| Code                  | HTTP Status | Description                      |
| --------------------- | ----------- | -------------------------------- |
| `INVALID_API_KEY`     | 401         | API key is invalid or expired    |
| `RATE_LIMIT_EXCEEDED` | 429         | Too many requests                |
| `VALIDATION_ERROR`    | 400         | Request data is invalid          |
| `RESOURCE_NOT_FOUND`  | 404         | Requested resource doesn't exist |
| `INTERNAL_ERROR`      | 500         | Server error, retry the request  |

## Webhooks

Configure webhooks to receive real-time updates:

```bash theme={null}
curl -X POST "https://api.steerai.autos/v1/webhooks" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-app.com/webhooks/steerai",
    "events": ["inspection.completed", "pricing.calculated"]
  }'
```

## Support

* **Technical Support:** [support@steerai.autos](mailto:support@steerai.autos)
* **API Status:** [status.steerai.autos](https://status.steerai.autos)
* **Changelog:** Check our [changelog](/support/changelog) for API updates
