CarsXE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CarsXE Recognition API

3 actions 3 updates phrasing extends openapi/carsxe-recognition-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['/platerecognition'].post
$.paths['/v1/vinocr'].post

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 Recognition API
  version: 1.0.0
extends: openapi/carsxe-recognition-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['/platerecognition'].post
  update:
    x-apievangelist-phrasing:
      intent: Read a license plate number from a car photo
      effect: read
      questions:
      - Can I read the license plate number from a photo of a car?
      - How do I extract plate text from a vehicle image URL?
      instructions:
      - text: Read the license plate number in the image at {image_url}.
        slots:
          image_url: requestBody.image_url
      - text: 'Extract the plate from this car photo: {image_url}.'
        slots:
          image_url: requestBody.image_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/vinocr'].post
  update:
    x-apievangelist-phrasing:
      intent: Extract a VIN from a photo
      effect: read
      questions:
      - Can I pull a VIN out of a picture of the dashboard or door sticker?
      - Does VIN OCR accept a base64-encoded image instead of a URL?
      instructions:
      - text: Extract the VIN from the photo at {image_url}.
        slots:
          image_url: requestBody.image_url
      - text: 'Run VIN OCR on this base64 image: {image_url}.'
        slots:
          image_url: requestBody.image_url
      method: generated
      generated: '2026-09-26'