CarsXE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CarsXE Market Value API

3 actions 3 updates phrasing extends openapi/carsxe-market-value-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for CarsXE's API. It is a proposal applied on top of the contract, not a document CarsXE publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/marketvalue'].get
$.paths['/v2/marketvalue'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for CarsXE Market Value API
  version: 1.0.0
extends: openapi/carsxe-market-value-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/marketvalue'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a vehicle's retail, trade-in and auction value
      effect: read
      questions:
      - What is the auction value of a car, alongside its retail and trade-in price?
      - How do I use the original v1 market value endpoint with just a VIN?
      - Can the basic market value lookup return XML?
      instructions:
      - text: Get the v1 retail, trade-in and auction values for VIN {vin}.
        slots:
          vin: query.vin
      - text: Look up the auction value of {vin} using the original market value endpoint in {format}.
        slots:
          vin: query.vin
          format: query.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/marketvalue'].get
  update:
    x-apievangelist-phrasing:
      intent: Get condition- and mileage-adjusted market values
      effect: read
      questions:
      - How much is my car worth wholesale given its mileage and condition?
      - Can I adjust a vehicle valuation for the US state it's sold in?
      - Which condition tiers does the v2 market value breakdown cover?
      instructions:
      - text: Get v2 wholesale, retail and trade-in values for VIN {vin} with {mileage} miles.
        slots:
          vin: query.vin
          mileage: query.mileage
      - text: Value VIN {vin} in {state} in {condition} condition.
        slots:
          vin: query.vin
          state: query.state
          condition: query.condition
      - text: Show the market values across every condition tier for {vin}.
        slots:
          vin: query.vin
      method: generated
      generated: '2026-09-26'