# 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 Afir Stream API
  version: 1.0.0
extends: openapi/thehiveryiq-com-afir-stream-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: 10
- target: $.paths['/v1/afir-stream/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check AFIR stream service health
      effect: read
      questions:
      - Is the afir-stream receipt service up?
      - Can I health-check the /v1/afir-stream endpoints specifically?
      instructions:
      - text: Check afir-stream health.
      - text: Ping the /v1/afir-stream service and report its status.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/afir-stream/segment'].post
  update:
    x-apievangelist-phrasing:
      intent: Receipt one stream segment (afir-stream path)
      effect: write
      questions:
      - How do I get a signed receipt for a single audio or token segment on the afir-stream path?
      - 'What roles can an afir-stream segment have: model, counterparty or system side?'
      instructions:
      - text: Receipt afir-stream segment {sequence} of session {session_id}, role {role}, hash {content_hash}.
        slots:
          sequence: requestBody.sequence
          session_id: requestBody.session_id
          role: requestBody.role
          content_hash: requestBody.content_hash
      - text: Sign segment {sequence} for session {session_id} via afir-stream with role {role} and content hash {content_hash}.
        slots:
          sequence: requestBody.sequence
          session_id: requestBody.session_id
          role: requestBody.role
          content_hash: requestBody.content_hash
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/afir-stream/seal'].post
  update:
    x-apievangelist-phrasing:
      intent: Seal a session's segments (afir-stream path)
      effect: write
      questions:
      - How do I seal an ordered list of segment receipts into one session receipt on afir-stream?
      - Can I declare a latency budget when sealing through afir-stream?
      instructions:
      - text: 'Seal these segment receipts via afir-stream: {segment_receipts}.'
        slots:
          segment_receipts: requestBody.segment_receipts
      - text: Seal session {session_id} on afir-stream from {segment_receipts} with budget {declared_budget_us} µs.
        slots:
          session_id: requestBody.session_id
          segment_receipts: requestBody.segment_receipts
          declared_budget_us: requestBody.declared_budget_us
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/afir-stream/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a segment or session receipt (afir-stream)
      effect: read
      questions:
      - How do I verify a sealed session receipt through the afir-stream endpoint?
      - Does afir-stream verification accept a single segment receipt too?
      instructions:
      - text: 'Verify this receipt with afir-stream: {receipt}.'
        slots:
          receipt: requestBody.receipt
      - text: Check the afir-stream signature on receipt {receipt}.
        slots:
          receipt: requestBody.receipt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/afir-stream/examples'].get
  update:
    x-apievangelist-phrasing:
      intent: Get sample payloads for afir-stream
      effect: read
      questions:
      - Where can I see example afir-stream segment and seal payloads?
      - Are there worked afir-stream examples to copy?
      instructions:
      - text: Show me the afir-stream examples.
      - text: Fetch the sample requests for /v1/afir-stream.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/afir/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check AFIR service health (short path)
      effect: read
      questions:
      - Is the short /v1/afir endpoint healthy?
      - Can I health-check the AFIR alias without the -stream suffix?
      instructions:
      - text: Check /v1/afir health.
      - text: Ping the short AFIR alias and report its status.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/afir/segment'].post
  update:
    x-apievangelist-phrasing:
      intent: Receipt one stream segment (short /v1/afir path)
      effect: write
      questions:
      - Can I post a segment receipt to the shorter /v1/afir route instead?
      - What fields does the /v1/afir segment call require?
      instructions:
      - text: Using /v1/afir, receipt segment {sequence} of {session_id} as {role} with hash {content_hash}.
        slots:
          sequence: requestBody.sequence
          session_id: requestBody.session_id
          role: requestBody.role
          content_hash: requestBody.content_hash
      - text: Post segment {sequence} for {session_id} to the short AFIR alias, role {role}, content {content_hash}.
        slots:
          sequence: requestBody.sequence
          session_id: requestBody.session_id
          role: requestBody.role
          content_hash: requestBody.content_hash
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/afir/seal'].post
  update:
    x-apievangelist-phrasing:
      intent: Seal a session's segments (short /v1/afir path)
      effect: write
      questions:
      - Can I seal a session using the /v1/afir alias rather than afir-stream?
      - What does the short AFIR seal return for my segment receipts?
      instructions:
      - text: Seal {segment_receipts} using the /v1/afir alias.
        slots:
          segment_receipts: requestBody.segment_receipts
      - text: Seal session {session_id} on the short AFIR route from {segment_receipts}.
        slots:
          session_id: requestBody.session_id
          segment_receipts: requestBody.segment_receipts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/afir/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a receipt (short /v1/afir path)
      effect: read
      questions:
      - Can I verify an AFIR receipt through the /v1/afir alias?
      - Will the short AFIR verify route check a sealed session?
      instructions:
      - text: Verify {receipt} using /v1/afir.
        slots:
          receipt: requestBody.receipt
      - text: Run the short AFIR verify on receipt {receipt}.
        slots:
          receipt: requestBody.receipt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/afir/examples'].get
  update:
    x-apievangelist-phrasing:
      intent: Get sample payloads for /v1/afir
      effect: read
      questions:
      - Where are the example payloads for the short /v1/afir alias?
      - Does the /v1/afir route publish its own samples?
      instructions:
      - text: Show the /v1/afir examples.
      - text: Fetch sample requests for the short AFIR alias.
      method: generated
      generated: '2026-09-26'