Stedi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stedi Enrollment Enrollments API

8 actions 8 updates phrasing extends openapi/stedi-enrollments-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 8

$.info
$.paths['/enrollments'].get
$.paths['/enrollments'].post
$.paths['/enrollments/export'].post
$.paths['/enrollments/{enrollmentId}'].get
$.paths['/enrollments/{enrollmentId}'].post
$.paths['/enrollments/{enrollmentId}'].delete
$.paths['/enrollments/{enrollmentId}/documents'].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 Stedi Enrollment Enrollments API
  version: 1.0.0
extends: openapi/stedi-enrollments-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: 7
- target: $.paths['/enrollments'].get
  update:
    x-apievangelist-phrasing:
      intent: List transaction enrollments
      effect: read
      questions:
      - Which of my providers' payer enrollments are still in progress?
      - Can I filter enrollments by provider NPI or payer ID?
      - What enrollments had a status change in the last week?
      instructions:
      - text: List enrollments with status {status}.
        slots:
          status: query.status
      - text: Show enrollments for provider NPI {providerNpis}.
        slots:
          providerNpis: query.providerNpis
      - text: List enrollments with payer {payerIds} whose status changed since {statusUpdatedFrom}.
        slots:
          payerIds: query.payerIds
          statusUpdatedFrom: query.statusUpdatedFrom
      method: generated
      generated: '2026-09-26'
- target: $.paths['/enrollments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a payer transaction enrollment
      effect: write
      questions:
      - How do I enroll a provider with a payer so they can receive ERAs?
      - What do I need to register a provider for claim transactions with an insurance payer?
      - Can I set a requested effective date on a new enrollment?
      instructions:
      - text: Enroll provider {provider} with payer {payer} for {transactions}.
        slots:
          provider: requestBody.provider
          payer: requestBody.payer
          transactions: requestBody.transactions
      - text: Create an enrollment for {provider} with {payer} effective {requestedEffectiveDate}, notifying {userEmail}.
        slots:
          provider: requestBody.provider
          payer: requestBody.payer
          requestedEffectiveDate: requestBody.requestedEffectiveDate
          userEmail: requestBody.userEmail
      method: generated
      generated: '2026-09-26'
- target: $.paths['/enrollments/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export enrollments to CSV
      effect: read
      questions:
      - Can I download my enrollment records as a spreadsheet?
      - How do I export only the enrollments for certain payers to CSV?
      instructions:
      - text: Export all my enrollments to a CSV file.
      - text: Export enrollments for payers {payerIds} as CSV.
        slots:
          payerIds: requestBody.payerIds
      - text: Create a CSV of enrollments with status {status}.
        slots:
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/enrollments/{enrollmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an enrollment
      effect: read
      questions:
      - What's the current status of a specific enrollment request?
      - Can I see the provider and payer details on one enrollment?
      instructions:
      - text: Show enrollment {enrollmentId}.
        slots:
          enrollmentId: path.enrollmentId
      - text: Check where enrollment {enrollmentId} stands.
        slots:
          enrollmentId: path.enrollmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/enrollments/{enrollmentId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a draft enrollment
      effect: write
      questions:
      - Can I edit an enrollment after it has been submitted?
      - How do I change the transaction types on a draft enrollment?
      instructions:
      - text: Update draft enrollment {enrollmentId} to cover {transactions}.
        slots:
          enrollmentId: path.enrollmentId
          transactions: requestBody.transactions
      - text: Change the primary contact on draft enrollment {enrollmentId} to {primaryContact}.
        slots:
          enrollmentId: path.enrollmentId
          primaryContact: requestBody.primaryContact
      method: generated
      generated: '2026-09-26'
- target: $.paths['/enrollments/{enrollmentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a draft enrollment
      effect: destructive
      questions:
      - How do I throw away an enrollment request I never submitted?
      - Can I delete an enrollment that's already been submitted to the payer?
      instructions:
      - text: Delete draft enrollment {enrollmentId}.
        slots:
          enrollmentId: path.enrollmentId
      - text: Discard the unsubmitted enrollment {enrollmentId}.
        slots:
          enrollmentId: path.enrollmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/enrollments/{enrollmentId}/documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an upload URL for an enrollment PDF
      effect: write
      questions:
      - How do I attach a signed PDF form to an enrollment task?
      - Where do I upload documents a payer asks for during enrollment?
      instructions:
      - text: Create an upload link for {name} on enrollment {enrollmentId} task {taskId}.
        slots:
          name: requestBody.name
          enrollmentId: path.enrollmentId
          taskId: requestBody.taskId
      - text: Upload a PDF named {name} to enrollment {enrollmentId} for task {taskId}.
        slots:
          name: requestBody.name
          enrollmentId: path.enrollmentId
          taskId: requestBody.taskId
      method: generated
      generated: '2026-09-26'