# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for CarsXE Plate Decoder API
  version: 1.0.0
extends: openapi/carsxe-plate-decoder-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: 3
- target: $.paths['/platedecoder'].get
  update:
    x-apievangelist-phrasing:
      intent: Decode a license plate with the legacy v1 endpoint
      effect: read
      questions:
      - Does the older v1 plate decoder still work with legacy country codes like UK or IND?
      - Can I decode a plate with the v1 endpoint and get XML back?
      - Which legacy state or country codes does the original plate decoder accept?
      instructions:
      - text: Decode plate {plate} registered in {state} with the legacy v1 plate decoder.
        slots:
          plate: query.plate
          state: query.state
      - text: Use the v1 decoder to look up plate {plate} in state {state}, country {country}, as {format}.
        slots:
          plate: query.plate
          state: query.state
          country: query.country
          format: query.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/us-platedecoder'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a US vehicle and its VIN by plate
      effect: read
      questions:
      - How do I find the VIN of a US car from its license plate and state?
      - Can a US plate lookup also return the full vehicle specifications?
      - Does the US plate decoder cover DC and Puerto Rico plates?
      - Is US plate lookup available on the free Sandbox tier?
      instructions:
      - text: Find the VIN, make, model and trim for US plate {plate} in {state}.
        slots:
          plate: query.plate
          state: query.state
      - text: Look up US plate {plate} from {state} and include full VIN specs with decodeVIN {decodeVIN}.
        slots:
          plate: query.plate
          state: query.state
          decodeVIN: query.decodeVIN
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/platedecoder'].get
  update:
    x-apievangelist-phrasing:
      intent: Decode a license plate from 60+ countries
      effect: read
      questions:
      - Can I decode a South African or Australian registration number into vehicle details?
      - What extra field do Pakistani plates from Khyber-Pakhtunkhwa need?
      - Is there an extra charge to always get a VIN back for Spanish plates?
      instructions:
      - text: Decode registration {plate} from country {country} with the v2 international plate decoder.
        slots:
          plate: query.plate
          country: query.country
      - text: Decode Canadian or Australian plate {plate} in country {country}, province or state {state}.
        slots:
          plate: query.plate
          country: query.country
          state: query.state
      - text: Decode Pakistani plate {plate} registered in district {district}.
        slots:
          plate: query.plate
          district: query.district
      - text: Decode Spanish plate {plate} and always include the VIN with require_vin {require_vin}.
        slots:
          plate: query.plate
          require_vin: query.require_vin
      method: generated
      generated: '2026-09-26'