AlgoVoi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Algovoi Co Uk Payable API

12 actions 12 updates phrasing extends openapi/algovoi-co-uk-payable-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 12

$.info
$.paths['/pay/v1/index'].get
$.paths['/pay/v1/negotiate'].get
$.paths['/pay/v1/negotiate'].post
$.paths['/pay/v1/verify/receipt'].get
$.paths['/pay/v1/verify/receipt'].post
$.paths['/pay/v1/verify/rfc9421'].get
$.paths['/pay/v1/verify/rfc9421'].post
$.paths['/pay/v1/screen/url'].get
$.paths['/pay/v1/screen/url'].post
$.paths['/pay/v1/compliance/receipt'].get
$.paths['/pay/v1/compliance/receipt'].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 Payable API
  version: 1.0.0
extends: openapi/algovoi-co-uk-payable-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: 11
- target: $.paths['/pay/v1/index'].get
  update:
    x-apievangelist-phrasing:
      intent: List the pay-per-call services
      effect: read
      questions:
      - Which pay-per-call verification services are available?
      - Is there an index of the paid endpoints and their prices?
      instructions:
      - text: Show the index of payable services.
      - text: List the pay-per-call endpoints on offer.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pay/v1/negotiate'].get
  update:
    x-apievangelist-phrasing:
      intent: See which chains and protocols can be negotiated
      effect: read
      questions:
      - Which payment chains and protocols can I negotiate for payable services?
      - What negotiation options does the payable API advertise?
      instructions:
      - text: Get the negotiable payment capabilities.
      - text: Show supported chains and protocols for paying per call.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pay/v1/negotiate'].post
  update:
    x-apievangelist-phrasing:
      intent: Negotiate payment terms for a service
      effect: write
      questions:
      - How do I agree a chain and protocol before paying for a service?
      - Can I negotiate terms for one specific payable service?
      instructions:
      - text: Negotiate payment for service {service_id} on chains {chains}.
        slots:
          service_id: requestBody.service_id
          chains: requestBody.chains
      - text: Agree terms using protocols {protocols} and chains {chains}.
        slots:
          protocols: requestBody.protocols
          chains: requestBody.chains
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pay/v1/verify/receipt'].get
  update:
    x-apievangelist-phrasing:
      intent: Probe the paid receipt verifier
      effect: read
      questions:
      - What does the paid receipt-verification service charge before I call it?
      - Can I check the receipt verifier's payment requirements with a GET?
      instructions:
      - text: Probe the paid receipt verifier for its payment terms.
      - text: GET the pay-per-call receipt verifier to see its challenge.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pay/v1/verify/receipt'].post
  update:
    x-apievangelist-phrasing:
      intent: Pay to verify a JWS receipt
      effect: write
      questions:
      - How do I pay per call to verify a JWS receipt?
      - Can the paid receipt check require the receipt and bind a payment hash?
      instructions:
      - text: Pay and verify receipt {jws}.
        slots:
          jws: requestBody.jws
      - text: Run a paid verification of {jws} bound to hash {expected_payment_hash}.
        slots:
          jws: requestBody.jws
          expected_payment_hash: requestBody.expected_payment_hash
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pay/v1/verify/rfc9421'].get
  update:
    x-apievangelist-phrasing:
      intent: Probe the paid RFC 9421 verifier
      effect: read
      questions:
      - What payment does the RFC 9421 signature verifier ask for?
      - Can I see the paid HTTP signature checker's challenge first?
      instructions:
      - text: Probe the paid RFC 9421 verifier.
      - text: GET the pay-per-call message signature checker to see its price.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pay/v1/verify/rfc9421'].post
  update:
    x-apievangelist-phrasing:
      intent: Pay to verify an RFC 9421 signed request
      effect: write
      questions:
      - How do I pay to have an HTTP message signature verified?
      - Can the paid signature check run in a specific mode or require a content digest?
      instructions:
      - text: Pay to verify the signature on {method} {path} at {authority} with key {public_key_hex} and headers {headers}.
        slots:
          method: requestBody.method
          path: requestBody.path
          authority: requestBody.authority
          public_key_hex: requestBody.public_key_hex
          headers: requestBody.headers
      - text: Run a paid RFC 9421 check in {mode} mode for key {public_key_hex}.
        slots:
          mode: requestBody.mode
          public_key_hex: requestBody.public_key_hex
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pay/v1/screen/url'].get
  update:
    x-apievangelist-phrasing:
      intent: Probe the paid URL screening service
      effect: read
      questions:
      - How much does it cost to screen a URL?
      - Can I see the URL screener's payment challenge before paying?
      instructions:
      - text: Probe the paid URL screener.
      - text: GET the URL screening service to read its payment terms.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pay/v1/screen/url'].post
  update:
    x-apievangelist-phrasing:
      intent: Pay to screen a URL
      effect: write
      questions:
      - How do I screen a link for risk before my agent visits it?
      - Can URL screening follow redirects and check TLS and RDAP?
      instructions:
      - text: Pay to screen URL {url}.
        slots:
          url: requestBody.url
      - text: Screen {url} following redirects {follow_redirects} with TLS check {do_tls}.
        slots:
          url: requestBody.url
          follow_redirects: requestBody.follow_redirects
          do_tls: requestBody.do_tls
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pay/v1/compliance/receipt'].get
  update:
    x-apievangelist-phrasing:
      intent: Probe the paid compliance receipt service
      effect: read
      questions:
      - What does it cost to get a compliance receipt?
      - Can I read the compliance receipt service's payment challenge?
      instructions:
      - text: Probe the paid compliance receipt service.
      - text: GET the compliance receipt endpoint to see its price.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pay/v1/compliance/receipt'].post
  update:
    x-apievangelist-phrasing:
      intent: Pay for a compliance receipt
      effect: write
      questions:
      - How do I buy a signed compliance receipt per call?
      - Can my agent pay for a compliance receipt over x402?
      instructions:
      - text: Pay for a compliance receipt.
      - text: Purchase a signed compliance receipt from the payable service.
      method: generated
      generated: '2026-10-01'