# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for CarsXE Recalls API
  version: 1.0.0
extends: openapi/carsxe-recalls-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: 6
- target: $.paths['/v1/recalls'].get
  update:
    x-apievangelist-phrasing:
      intent: Check open safety recalls for a VIN
      effect: read
      questions:
      - Does my specific car have any open safety recalls?
      - How do I check one VIN for unrepaired recalls?
      instructions:
      - text: Check VIN {vin} for open safety recalls.
        slots:
          vin: query.vin
      - text: List any unrepaired recalls on the vehicle with VIN {vin}.
        slots:
          vin: query.vin
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/recalls-ymm'].get
  update:
    x-apievangelist-phrasing:
      intent: Find recalls by year, make and model
      effect: read
      questions:
      - Can I look up recalls for a car model without knowing the VIN?
      - Are there open recalls on the 2019 Toyota Camry?
      instructions:
      - text: Find open recalls for the {year} {make} {model}.
        slots:
          year: query.year
          make: query.make
          model: query.model
      - text: Without a VIN, check model year {year} {make} {model} for safety recalls.
        slots:
          year: query.year
          make: query.make
          model: query.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/recalls-batch/submit'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a bulk batch of VINs for recall checks
      effect: write
      questions:
      - How do I check thousands of VINs for recalls in one go?
      - Can I upload a CSV of VINs for a bulk recall check and get a webhook when it's done?
      - What is the maximum number of VINs a single recall batch accepts?
      instructions:
      - text: 'Submit a recall batch for these VINs: {vins}.'
        slots:
          vins: requestBody.vins
      - text: Start a bulk recall check from the CSV file at {csvUrl} and notify {webhookUrl} when it finishes.
        slots:
          csvUrl: requestBody.csvUrl
          webhookUrl: requestBody.webhookUrl
      - text: 'Queue a recall batch from this inline CSV text: {csv}.'
        slots:
          csv: requestBody.csv
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/recalls-batch/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the progress of a bulk recall batch
      effect: read
      questions:
      - Is my bulk recall batch finished processing yet?
      - How can I poll a submitted recall batch until it completes?
      instructions:
      - text: Check the processing status of recall batch {batchId}.
        slots:
          batchId: query.batchId
      - text: Poll whether batch {batchId} is done using batch token {token}.
        slots:
          batchId: query.batchId
          token: header.X-CarsXE-Batch-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/recalls-batch/results'].get
  update:
    x-apievangelist-phrasing:
      intent: Get per-VIN results of a completed recall batch
      effect: read
      questions:
      - Where do I get the per-VIN recall findings once a batch completes, as JSON?
      - Can I read recall batch results with the x402 batch token instead of an API key?
      instructions:
      - text: Fetch the JSON per-VIN recall results for batch {batchId}.
        slots:
          batchId: query.batchId
      - text: Get the recall results of batch {batchId} authenticating with batch token {token}.
        slots:
          batchId: query.batchId
          token: header.X-CarsXE-Batch-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/recalls-batch/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download recall batch results as CSV
      effect: read
      questions:
      - Can I download a finished recall batch as a CSV spreadsheet?
      - Is there a file export of bulk recall results for Excel?
      instructions:
      - text: Download the CSV of recall results for batch {batchId}.
        slots:
          batchId: query.batchId
      - text: Export batch {batchId} recall results to CSV using batch token {token}.
        slots:
          batchId: query.batchId
          token: header.X-CarsXE-Batch-Token
      method: generated
      generated: '2026-09-26'