AlgoVoi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Algovoi Co Uk Verify API

9 actions 9 updates phrasing extends openapi/algovoi-co-uk-verify-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for AlgoVoi's API. It is a proposal applied on top of the contract, not a document AlgoVoi publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/verify'].post
$.paths['/verify/rfc9421'].get
$.paths['/verify/rfc9421'].post
$.paths['/verify/rfc9421/explain'].post
$.paths['/verify/rfc9421/sign'].post
$.paths['/v1/verify'].post
$.paths['/verify/action-ref'].get
$.paths['/verify/action-ref'].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 Algovoi Co Uk Verify API
  version: 1.0.0
extends: openapi/algovoi-co-uk-verify-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify an audit bundle
      effect: read
      questions:
      - How do I check an audit bundle's integrity without storing it anywhere?
      - Can the audit bundle signature be verified too?
      instructions:
      - text: Verify this audit bundle.
      - text: Check my audit bundle, including its signature with the supplied key.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/verify/rfc9421'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the RFC 9421 verifier's input schema
      effect: read
      questions:
      - What input does the free RFC 9421 verifier expect?
      - Which spec does the HTTP message signature verifier implement?
      instructions:
      - text: Show the RFC 9421 verifier input schema.
      - text: Get the spec reference for the HTTP signature verifier.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/verify/rfc9421'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a signed HTTP message offline
      effect: read
      questions:
      - Can I verify an HTTP message signature against the key I expect the signer to hold?
      - Does the free signature verifier error out on a bad signature, or return valid false?
      instructions:
      - text: Verify this signed message envelope against my expected key.
      - text: Check offline whether this RFC 9421 signed request is valid.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/verify/rfc9421/explain'].post
  update:
    x-apievangelist-phrasing:
      intent: Explain why an HTTP signature passes or fails
      effect: read
      questions:
      - Why is my RFC 9421 signature failing, and how do I fix it?
      - Can I see the exact canonical signing base the verifier computed?
      instructions:
      - text: Explain why this signed request fails and show the signing base.
      - text: Debug my message signature and give how-to-fix notes.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/verify/rfc9421/sign'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign a sample request with a demo key
      effect: read
      questions:
      - Is there a reference signer I can diff my own RFC 9421 signer against?
      - Do I need to send a private key to get a correctly signed example?
      instructions:
      - text: Sign these request inputs with a throwaway demo key.
      - text: Produce a known-good signed request and signing base for comparison.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify an MPP on-chain payment transaction
      effect: write
      questions:
      - How does the MPP adapter confirm a payer's on-chain transaction?
      - What does the gateway return when an MPP payment checks out, a receipt JWT?
      instructions:
      - text: Verify tx {tx_id} on {network} for resource {resource_id}.
        slots:
          tx_id: requestBody.tx_id
          network: requestBody.network
          resource_id: requestBody.resource_id
      - text: Confirm MPP payment {tx_id} for {resource_id} and return the receipt.
        slots:
          tx_id: requestBody.tx_id
          resource_id: requestBody.resource_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/verify/action-ref'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the action_ref verifier's input schema
      effect: read
      questions:
      - What fields does the action_ref verifier take?
      - Where is the spec reference for computing an action_ref?
      instructions:
      - text: Show the action_ref verifier schema.
      - text: Get the spec reference for action_ref hashing.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/verify/action-ref'].post
  update:
    x-apievangelist-phrasing:
      intent: Compute the canonical action_ref hash
      effect: read
      questions:
      - How do I check my implementation computes the same action_ref hash as production?
      - What canonical form is the action_ref hashed from?
      instructions:
      - text: Compute the action_ref for agent {agent_id}, action {action_type}, scope {scope} at {timestamp_ms}.
        slots:
          agent_id: requestBody.agent_id
          action_type: requestBody.action_type
          scope: requestBody.scope
          timestamp_ms: requestBody.timestamp_ms
      - text: Hash action {action_type} by {agent_id} with scope {scope} at {timestamp_ms} ms.
        slots:
          action_type: requestBody.action_type
          agent_id: requestBody.agent_id
          scope: requestBody.scope
          timestamp_ms: requestBody.timestamp_ms
      method: generated
      generated: '2026-10-01'