CarsXE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CarsXE History API

2 actions 2 updates phrasing extends openapi/carsxe-history-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 2

$.info
$.paths['/history'].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 History API
  version: 1.0.0
extends: openapi/carsxe-history-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: 1
- target: $.paths['/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a vehicle history report by VIN
      effect: read
      questions:
      - Has this used car ever had a salvage or junk title?
      - How do I pull a vehicle history report with title and insurance records from a VIN?
      - Can I get the history report back as XML instead of JSON?
      instructions:
      - text: Pull the vehicle history report for VIN {vin}.
        slots:
          vin: query.vin
      - text: Check VIN {vin} for title brands, junk or salvage records and insurance history.
        slots:
          vin: query.vin
      - text: Get the history report for {vin} in {format} format.
        slots:
          vin: query.vin
          format: query.format
      method: generated
      generated: '2026-09-26'