Stedi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stedi Manager Batch eligibility check API

5 actions 5 updates phrasing extends openapi/stedi-batch-eligibility-check-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Stedi's API. It is a proposal applied on top of the contract, not a document Stedi publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/eligibility-manager/batch-eligibility'].post
$.paths['/eligibility-manager/batch/{batchId}'].get
$.paths['/eligibility-manager/batch/{batchId}/items'].get
$.paths['/eligibility-manager/polling/batch-eligibility'].get

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 Stedi Manager Batch eligibility check API
  version: 1.0.0
extends: openapi/stedi-batch-eligibility-check-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['/eligibility-manager/batch-eligibility'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a batch of eligibility checks
      effect: write
      questions:
      - How do I run eligibility checks for a whole list of patients at once in Stedi?
      - Can I give a batch of insurance eligibility checks a name so I can find it later?
      - Is there a way to have asynchronous eligibility checks keep retrying for a set number of hours?
      instructions:
      - text: Submit these {items} as one batch of eligibility checks.
        slots:
          items: requestBody.items
      - text: Start a batch eligibility run named {name} for {items}.
        slots:
          name: requestBody.name
          items: requestBody.items
      - text: Queue {items} as a batch eligibility job and retry failures for up to {maxRetryHours} hours.
        slots:
          items: requestBody.items
          maxRetryHours: requestBody.maxRetryHours
      method: generated
      generated: '2026-09-26'
- target: $.paths['/eligibility-manager/batch/{batchId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of an eligibility batch
      effect: read
      questions:
      - Has my batch of eligibility checks finished processing yet?
      - Where can I see the overall progress of an eligibility batch I uploaded as a CSV?
      instructions:
      - text: Show the overall status of eligibility batch {batchId}.
        slots:
          batchId: path.batchId
      - text: Tell me whether batch {batchId} is still running.
        slots:
          batchId: path.batchId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/eligibility-manager/batch/{batchId}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List the checks inside an eligibility batch
      effect: read
      questions:
      - Which individual eligibility checks in my batch are still pending?
      - Can I filter the checks in a batch to only patients whose coverage came back active?
      - What status does each patient check in a batch have?
      instructions:
      - text: List every check in eligibility batch {batchId}.
        slots:
          batchId: path.batchId
      - text: Show the checks in batch {batchId} that are in state {state}.
        slots:
          batchId: path.batchId
          state: query.state
      - text: Find checks in batch {batchId} with the result {eligibilityCheckResult}.
        slots:
          batchId: path.batchId
          eligibilityCheckResult: query.eligibilityCheckResult
      method: generated
      generated: '2026-09-26'
- target: $.paths['/eligibility-manager/polling/batch-eligibility'].get
  update:
    x-apievangelist-phrasing:
      intent: Poll for completed batch eligibility results
      effect: read
      questions:
      - How do I pull the actual benefits responses from my asynchronous eligibility checks?
      - Can I fetch only the batch eligibility results that completed after a certain time?
      instructions:
      - text: Poll for batch eligibility results completed since {startDateTime}.
        slots:
          startDateTime: query.startDateTime
      - text: Download the finished eligibility responses for batch {batchId}.
        slots:
          batchId: query.batchId
      - text: Fetch the latest completed batch eligibility results.
      method: generated
      generated: '2026-09-26'