# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for OpenAI Batch API
  version: 1.0.0
extends: openapi/openai-batch-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: 4
- target: $.paths['/batches'].get
  update:
    x-apievangelist-phrasing:
      intent: List my organization's batches
      effect: read
      questions:
      - Which batch jobs has my organization submitted?
      - Can I page through older batches?
      instructions:
      - text: List our batches.
      - text: Show the next {limit} batches after {after}.
        slots:
          limit: query.limit
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a batch of requests from a file
      effect: write
      questions:
      - How do I run a large file of API requests asynchronously as a batch?
      - What completion window can I choose for a batch?
      - Can I control how long a batch's output file is kept?
      instructions:
      - text: Run batch file {input_file_id} against {endpoint} within {completion_window}.
        slots:
          input_file_id: requestBody.input_file_id
          endpoint: requestBody.endpoint
          completion_window: requestBody.completion_window
      - text: Submit {input_file_id} as a batch to {endpoint} with a {completion_window} window, tagged {metadata}.
        slots:
          input_file_id: requestBody.input_file_id
          endpoint: requestBody.endpoint
          completion_window: requestBody.completion_window
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches/{batch_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a batch
      effect: read
      questions:
      - Has my batch finished, and where is its output file?
      - How many requests in a batch have failed so far?
      instructions:
      - text: Show batch {batch_id}.
        slots:
          batch_id: path.batch_id
      - text: Check the progress of batch {batch_id}.
        slots:
          batch_id: path.batch_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches/{batch_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an in-progress batch
      effect: destructive
      questions:
      - How do I stop a batch that is still running?
      - Do I keep partial results if I cancel a batch?
      instructions:
      - text: Cancel batch {batch_id}.
        slots:
          batch_id: path.batch_id
      - text: Stop the running batch {batch_id} and keep whatever finished.
        slots:
          batch_id: path.batch_id
      method: generated
      generated: '2026-09-26'