# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Thehiveryiq Com Clear API
  version: 1.0.0
extends: openapi/thehiveryiq-com-clear-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: 12
- target: $.paths['/v1/clear/how_to_pay'].get
  update:
    x-apievangelist-phrasing:
      intent: Learn how to pay for CLEAR services
      effect: read
      questions:
      - What payment options can my agent use to settle into HiveMorph CLEAR?
      - Is there any out-of-band setup needed before paying for CLEAR calls?
      instructions:
      - text: Show me the payment options for settling CLEAR calls.
      - text: Get the inline how-to-pay instructions for CLEAR.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/clear/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the CLEAR service health
      effect: read
      questions:
      - Is the CLEAR prior authorization service up right now?
      - Can I ping CLEAR to confirm it is responding?
      instructions:
      - text: Check the health of the CLEAR service.
      - text: Confirm CLEAR is online.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/clear/pricing'].get
  update:
    x-apievangelist-phrasing:
      intent: Get CLEAR pricing
      effect: read
      questions:
      - What does CLEAR charge for prior authorization receipts and attestations?
      - Where can I see the current CLEAR price list?
      instructions:
      - text: Show the CLEAR pricing table.
      - text: Get current CLEAR prices.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/clear/pa/submit'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a prior authorization request
      effect: write
      questions:
      - How do I submit a prior authorization with CPT and ICD-10 codes and get a signed receipt?
      - Can I mark a prior authorization as urgent when submitting it?
      instructions:
      - text: 'Submit a PA from {provider} to payer {payer} for member {member}: CPT {cpt}, ICD-10 {icd10}, doc hash {doc_hash}.'
        slots:
          provider: requestBody.provider_did
          payer: requestBody.payer_did
          member: requestBody.member_did
          cpt: requestBody.cpt_codes
          icd10: requestBody.icd10_codes
          doc_hash: requestBody.clinical_doc_hash
      - text: File an {urgency} PA for member {member} with payer {payer}, provider {provider}, CPT {cpt}, ICD-10 {icd10}, doc {doc_hash}.
        slots:
          urgency: requestBody.urgency
          member: requestBody.member_did
          payer: requestBody.payer_did
          provider: requestBody.provider_did
          cpt: requestBody.cpt_codes
          icd10: requestBody.icd10_codes
          doc_hash: requestBody.clinical_doc_hash
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/clear/pa/{pa_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a stored prior authorization
      effect: read
      questions:
      - Can I pull back the details of a prior authorization I already submitted?
      - What was stored for a given PA id?
      instructions:
      - text: Get prior authorization {pa_id}.
        slots:
          pa_id: path.pa_id
      - text: Show me the stored PA record {pa_id}.
        slots:
          pa_id: path.pa_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/clear/pa/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a prior authorization's signed receipt
      effect: read
      questions:
      - How can I check that a PA's dual-signed receipt is valid?
      - Is the submission receipt for this prior authorization authentic?
      instructions:
      - text: Verify the dual-signed receipt for PA {pa_id}.
        slots:
          pa_id: requestBody.pa_id
      - text: Check the submission signature on prior authorization {pa_id}.
        slots:
          pa_id: requestBody.pa_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/clear/decision/attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Attest a payer's approve, deny or pend decision
      effect: write
      questions:
      - How do I record a payer's approval or denial of a prior authorization?
      - Does a decision attestation need a reason code?
      instructions:
      - text: Attest payer decision {decision} with reason {decision_reason_code} on PA {pa_id}, chained to {prior_attestation_id}.
        slots:
          decision: requestBody.decision
          decision_reason_code: requestBody.decision_reason_code
          pa_id: requestBody.pa_id
          prior_attestation_id: requestBody.prior_attestation_id
      - text: Record that the payer denied PA {pa_id} with code {decision_reason_code}, after attestation {prior_attestation_id}; decision {decision}.
        slots:
          pa_id: requestBody.pa_id
          decision_reason_code: requestBody.decision_reason_code
          prior_attestation_id: requestBody.prior_attestation_id
          decision: requestBody.decision
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/clear/p2p/attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Attest a peer-to-peer review outcome
      effect: write
      questions:
      - How do I record the outcome of a peer-to-peer review on a PA decision?
      - Can a peer-to-peer review be chained to the decision it challenged?
      instructions:
      - text: Attest peer-to-peer outcome {p2p_outcome} for decision {decision_id} on PA {pa_id}, chained to {prior_attestation_id}.
        slots:
          p2p_outcome: requestBody.p2p_outcome
          decision_id: requestBody.decision_id
          pa_id: requestBody.pa_id
          prior_attestation_id: requestBody.prior_attestation_id
      - text: Log the peer-to-peer review of decision {decision_id} (PA {pa_id}) as {p2p_outcome}, prior attestation {prior_attestation_id}.
        slots:
          decision_id: requestBody.decision_id
          pa_id: requestBody.pa_id
          p2p_outcome: requestBody.p2p_outcome
          prior_attestation_id: requestBody.prior_attestation_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/clear/appeal/attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Attest an appeal of a denial
      effect: write
      questions:
      - How do I record an appeal against a prior authorization denial?
      - Can I note which appeal level was reached and how it turned out?
      instructions:
      - text: Attest a level {appeal_level} appeal of decision {decision_id} on PA {pa_id} with outcome {appeal_outcome}, chained to {prior_attestation_id}.
        slots:
          appeal_level: requestBody.appeal_level
          decision_id: requestBody.decision_id
          pa_id: requestBody.pa_id
          appeal_outcome: requestBody.appeal_outcome
          prior_attestation_id: requestBody.prior_attestation_id
      - text: Record appeal outcome {appeal_outcome} at level {appeal_level} against denial {decision_id} for PA {pa_id}, after {prior_attestation_id}.
        slots:
          appeal_outcome: requestBody.appeal_outcome
          appeal_level: requestBody.appeal_level
          decision_id: requestBody.decision_id
          pa_id: requestBody.pa_id
          prior_attestation_id: requestBody.prior_attestation_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/clear/chain/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a PA's full lifecycle chain
      effect: read
      questions:
      - Can I verify every attestation from submission through appeal for a prior authorization?
      - Is the whole decision and appeal chain for this PA intact?
      instructions:
      - text: Verify the full lifecycle chain for PA {pa_id}.
        slots:
          pa_id: requestBody.pa_id
      - text: Check that every attestation linked to PA {pa_id} chains correctly.
        slots:
          pa_id: requestBody.pa_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/clear/by-payer/{payer_did}'].get
  update:
    x-apievangelist-phrasing:
      intent: List prior authorizations sent to a payer
      effect: read
      questions:
      - Which prior authorizations have been submitted to a particular payer?
      - Can I page through a payer's PA history?
      instructions:
      - text: List PA submissions for payer {payer_did}.
        slots:
          payer_did: path.payer_did
      - text: Show {limit} PAs for payer {payer_did} starting at offset {offset}.
        slots:
          limit: query.limit
          payer_did: path.payer_did
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/clear/by-provider/{provider_did}'].get
  update:
    x-apievangelist-phrasing:
      intent: List prior authorizations from a provider
      effect: read
      questions:
      - What prior authorizations has a given care provider submitted?
      - Can I paginate a provider's PA submission history?
      instructions:
      - text: List PA submissions from provider {provider_did}.
        slots:
          provider_did: path.provider_did
      - text: Show {limit} PAs submitted by provider {provider_did}, offset {offset}.
        slots:
          limit: query.limit
          provider_did: path.provider_did
          offset: query.offset
      method: generated
      generated: '2026-09-26'