logo
API docs by Redocly

Carvis API (1.0.0)

Download OpenAPI specification:

API documentation for Carvis services

Authentication

Authentication and authorization endpoints

Exchange token for access token

Exchange a token for an access token with a 15-minute expiration

Request Body schema: application/json
required
client_id
required
string

The client ID to exchange for an access token

client_secret
required
string

The client secret to exchange for an access token

Responses

Request samples

Content type
application/json
{
  • "client_id": "your-client-id-here",
  • "client_secret": "your-client-secret-here"
}

Response samples

Content type
application/json
{
  • "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "token_type": "Bearer",
  • "expires_at": "2024-03-21T15:30:00.000Z"
}

Quotes

Vehicle repair quote management

Generate a repair quote

Generate a quote for vehicle repair services based on the vehicle's VIN and search criteria.

Authorizations:
bearerAuth
Request Body schema: application/json
required
shopId
required
string

ID of the shop to generate the quote for

vin
required
string

Vehicle Identification Number (VIN) of the vehicle

prompt
required
string

Prompt to generate the quote

Responses

Request samples

Content type
application/json
{
  • "shopId": "123e4567-e89b-12d3-a456-426614174000",
  • "vin": "1HGCM82633A123456",
  • "prompt": "I need an oil change and brake inspection"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "vehicle": {
    },
  • "shop": {
    },
  • "quote_part_items": [
    ],
  • "quote_labor_items": [
    ]
}

Health

API health check endpoints

Root endpoint

Returns a simple greeting message. This endpoint is public and does not require authentication.

Responses

Response samples

Content type
application/json
{
  • "message": "Welcome to Carvis API"
}

Shops

Get all shops

Retrieve a list of all available repair shops for the authenticated organization

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new shop

Create a new repair shop entry for the authenticated organization

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string

Name of the shop

address1
required
string

Primary address line of the shop

address2
string

Secondary address line of the shop

phone
required
string

Contact phone number

email
required
string <email>

Contact email

city
required
string

City where the shop is located

state
required
string

State where the shop is located

zip
required
string

ZIP code of the shop location

county
required
string

County where the shop is located

website
string

Shop's website URL

external_id
required
string

External identifier for the shop

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "phone": "string",
  • "email": "user@example.com",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "county": "string",
  • "website": "string",
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "shop": {
    }
}