Stedi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stedi Healthcare Remittances API

3 actions 3 updates phrasing extends openapi/stedi-remittances-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 3

$.info

$.paths['/change/medicalnetwork/reports/v2/{transactionId}/835'].get

$.paths['/electronic-remittance-advice/{transactionId}/pdf'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stedi Healthcare Remittances API
  version: 1.0.0
extends: openapi/stedi-remittances-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['/change/medicalnetwork/reports/v2/{transactionId}/835'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an 835 remittance advice as JSON
      effect: read
      questions:
      - How do I see what a payer paid and adjusted on my claims from an ERA?
      - Can I read an 835 electronic remittance advice as JSON?
      instructions:
      - text: Retrieve the 835 ERA for transaction {transactionId} in JSON.
        slots:
          transactionId: path.transactionId
      - text: Show payment details from remittance {transactionId}.
        slots:
          transactionId: path.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/electronic-remittance-advice/{transactionId}/pdf'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an 835 remittance advice as a PDF
      effect: read
      questions:
      - Can I get a printable PDF of an ERA?
      - Is it possible to remove the logo from the footer of the remittance PDF?
      instructions:
      - text: Download the ERA PDF for transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      - text: Get the remittance PDF for {transactionId} with logo set to {logo}.
        slots:
          transactionId: path.transactionId
          logo: query.logo
      method: generated
      generated: '2026-09-26'