CarsXE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CarsXE Specifications API

3 actions 3 updates phrasing extends openapi/carsxe-specifications-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['/specs'].get

$.paths['/v1/international-vin-decoder'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for CarsXE Specifications API
  version: 1.0.0
extends: openapi/carsxe-specifications-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['/specs'].get
  update:
    x-apievangelist-phrasing:
      intent: Decode a VIN into full vehicle specifications
      effect: read
      questions:
      - How do I decode a VIN into equipment, colors and warranty details?
      - Can I request deeper data from a VIN decode even if it's slower?
      - Can I stop the specs decoder from falling back to international decoding?
      instructions:
      - text: Decode VIN {vin} and return its full specifications.
        slots:
          vin: query.vin
      - text: Get specs for {vin} with the extra deep data option {deepdata}.
        slots:
          vin: query.vin
          deepdata: query.deepdata
      - text: Decode {vin} without the international fallback, disableIntVINDecoding {disableIntVINDecoding}.
        slots:
          vin: query.vin
          disableIntVINDecoding: query.disableIntVINDecoding
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/international-vin-decoder'].get
  update:
    x-apievangelist-phrasing:
      intent: Decode a non-US VIN
      effect: read
      questions:
      - Can I decode a VIN from a car built for the European or Asian market?
      - What vehicle attributes come back for an international VIN?
      instructions:
      - text: Decode the non-US VIN {vin}.
        slots:
          vin: query.vin
      - text: Run the international VIN decoder on {vin}.
        slots:
          vin: query.vin
      method: generated
      generated: '2026-09-26'