# 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 Alcoa Agentguard API
  version: 1.0.0
extends: openapi/thehiveryiq-com-alcoa-agentguard-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: 11
- target: $.paths['/v1/alcoa-agentguard/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check ALCOA AgentGuard service health
      effect: read
      questions:
      - Is the clinical-trial ALCOA attestation service running?
      - Can I health-check AgentGuard before recording trial events?
      instructions:
      - text: Check the health of the ALCOA AgentGuard service.
      - text: Ping AgentGuard to see if it's up.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/alcoa-agentguard/pricing'].get
  update:
    x-apievangelist-phrasing:
      intent: See ALCOA AgentGuard pricing
      effect: read
      questions:
      - How much does it cost to attest clinical trial events?
      - What is the price per AgentGuard receipt?
      instructions:
      - text: Show me ALCOA AgentGuard pricing.
      - text: Get the price list for clinical trial attestations.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/alcoa-agentguard/protocol_attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a trial protocol or amendment event
      effect: write
      questions:
      - How do I create a tamper-evident record of a trial protocol amendment?
      - Can I attest a new study protocol version for a clinical trial?
      instructions:
      - text: Attest a protocol event for trial {trial_id} by {attributable_did} with payload hash {original_payload_hash}.
        slots:
          trial_id: requestBody.trial_id
          attributable_did: requestBody.attributable_did
          original_payload_hash: requestBody.original_payload_hash
      - text: Record protocol amendment {event_payload} on trial {trial_id}, attributed to {attributable_did}, hash {original_payload_hash}.
        slots:
          event_payload: requestBody.event_payload
          trial_id: requestBody.trial_id
          attributable_did: requestBody.attributable_did
          original_payload_hash: requestBody.original_payload_hash
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/alcoa-agentguard/consent_attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a patient consent event
      effect: write
      questions:
      - How do I prove which IRB-approved consent form a patient signed?
      - Can I attest patient informed consent with the IRB version hash?
      instructions:
      - text: Attest patient consent for trial {trial_id} by {attributable_did} under IRB version {irb_version_hash}, payload hash {original_payload_hash}.
        slots:
          trial_id: requestBody.trial_id
          attributable_did: requestBody.attributable_did
          irb_version_hash: requestBody.irb_version_hash
          original_payload_hash: requestBody.original_payload_hash
      - text: Record a consent signature on {trial_id} against IRB form {irb_version_hash} (hash {original_payload_hash}, by {attributable_did}).
        slots:
          trial_id: requestBody.trial_id
          irb_version_hash: requestBody.irb_version_hash
          original_payload_hash: requestBody.original_payload_hash
          attributable_did: requestBody.attributable_did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/alcoa-agentguard/enrollment_attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a trial enrollment event
      effect: write
      questions:
      - How do I log a subject enrolling in a clinical trial with a signed receipt?
      - Can enrollment events be attributed to the site agent that recorded them?
      instructions:
      - text: Attest an enrollment in trial {trial_id} by {attributable_did} with payload hash {original_payload_hash}.
        slots:
          trial_id: requestBody.trial_id
          attributable_did: requestBody.attributable_did
          original_payload_hash: requestBody.original_payload_hash
      - text: Record subject enrollment {event_payload} for trial {trial_id} (hash {original_payload_hash}, by {attributable_did}).
        slots:
          event_payload: requestBody.event_payload
          trial_id: requestBody.trial_id
          original_payload_hash: requestBody.original_payload_hash
          attributable_did: requestBody.attributable_did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/alcoa-agentguard/dosing_attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a trial dosing event
      effect: write
      questions:
      - How do I create an ALCOA-compliant record that a study dose was administered?
      - Can I attest each dosing event in a trial?
      instructions:
      - text: Attest a dosing event for trial {trial_id} by {attributable_did}, payload hash {original_payload_hash}.
        slots:
          trial_id: requestBody.trial_id
          attributable_did: requestBody.attributable_did
          original_payload_hash: requestBody.original_payload_hash
      - text: Record dose administration {event_payload} on trial {trial_id} with hash {original_payload_hash} by {attributable_did}.
        slots:
          event_payload: requestBody.event_payload
          trial_id: requestBody.trial_id
          original_payload_hash: requestBody.original_payload_hash
          attributable_did: requestBody.attributable_did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/alcoa-agentguard/adverse_event_attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an adverse event, SAE or SUSAR
      effect: write
      questions:
      - How do I log a serious adverse event in a trial with a signed receipt?
      - Can I classify the attested event as an AE, SAE or SUSAR?
      instructions:
      - text: Attest an adverse event of type {ae_type} for trial {trial_id} by {attributable_did}, hash {original_payload_hash}.
        slots:
          ae_type: requestBody.ae_type
          trial_id: requestBody.trial_id
          attributable_did: requestBody.attributable_did
          original_payload_hash: requestBody.original_payload_hash
      - text: Record a safety event on trial {trial_id} with payload hash {original_payload_hash}, reported by {attributable_did}.
        slots:
          trial_id: requestBody.trial_id
          original_payload_hash: requestBody.original_payload_hash
          attributable_did: requestBody.attributable_did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/alcoa-agentguard/data_transfer_attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a trial data handoff to a CRO
      effect: write
      questions:
      - How do I prove trial data was handed off to a CRO and to whom?
      - Can I attest a data transfer with the recipient's DID?
      instructions:
      - text: Attest a data transfer on trial {trial_id} from {attributable_did} to {recipient_did}, hash {original_payload_hash}.
        slots:
          trial_id: requestBody.trial_id
          attributable_did: requestBody.attributable_did
          recipient_did: requestBody.recipient_did
          original_payload_hash: requestBody.original_payload_hash
      - text: Record handing off trial {trial_id} data to CRO {recipient_did} (hash {original_payload_hash}, sender {attributable_did}).
        slots:
          trial_id: requestBody.trial_id
          recipient_did: requestBody.recipient_did
          original_payload_hash: requestBody.original_payload_hash
          attributable_did: requestBody.attributable_did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/alcoa-agentguard/database_lock_attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a trial database lock
      effect: write
      questions:
      - How do I attest that a clinical trial database was locked?
      - Can a database lock be recorded with a hash of the locked data?
      instructions:
      - text: Attest the database lock for trial {trial_id} by {attributable_did} with hash {original_payload_hash}.
        slots:
          trial_id: requestBody.trial_id
          attributable_did: requestBody.attributable_did
          original_payload_hash: requestBody.original_payload_hash
      - text: Record that trial {trial_id}'s database is locked, snapshot hash {original_payload_hash}, signed off by {attributable_did}.
        slots:
          trial_id: requestBody.trial_id
          original_payload_hash: requestBody.original_payload_hash
          attributable_did: requestBody.attributable_did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/alcoa-agentguard/chain_verify'].get
  update:
    x-apievangelist-phrasing:
      intent: Verify a trial's receipt chain
      effect: read
      questions:
      - How do I check that every attested event for a trial is intact and correctly signed?
      - Can I get the ordered chain of receipts for a clinical trial?
      instructions:
      - text: Verify the receipt chain for trial {trial_id}.
        slots:
          trial_id: query.trial_id
      - text: Show the ordered signed events for trial {trial_id} and whether the chain is valid.
        slots:
          trial_id: query.trial_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/alcoa-agentguard/alcoa_audit'].get
  update:
    x-apievangelist-phrasing:
      intent: Score a trial's ALCOA+ completeness
      effect: read
      questions:
      - How complete are a trial's records against the nine ALCOA+ attributes?
      - Which receipts in my trial fail ALCOA+ checks?
      instructions:
      - text: Run an ALCOA+ audit for trial {trial_id}.
        slots:
          trial_id: query.trial_id
      - text: Give me the ALCOA+ completeness report for {trial_id}.
        slots:
          trial_id: query.trial_id
      method: generated
      generated: '2026-09-26'