AlgoVoi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Algovoi Co Uk Suite Store API

5 actions 5 updates phrasing extends openapi/algovoi-co-uk-suite-store-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 5

$.info
$.paths['/suite-store/checkout'].post
$.paths['/suite-store/settled'].post
$.paths['/suite-store/order/{token}/activate'].post
$.paths['/suite-store/order/{token}/status'].get

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 Suite Store API
  version: 1.0.0
extends: openapi/algovoi-co-uk-suite-store-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: 4
- target: $.paths['/suite-store/checkout'].post
  update:
    x-apievangelist-phrasing:
      intent: Buy a suite package via hosted checkout
      effect: write
      questions:
      - How do I buy an AlgoVoi suite package?
      - Can I choose the network and term when ordering a suite package?
      instructions:
      - text: Start a checkout for package {package} for {email}.
        slots:
          package: requestBody.package
          email: requestBody.email
      - text: Order suite package {package} on {network} for term {term}, billed to {email}.
        slots:
          package: requestBody.package
          network: requestBody.network
          term: requestBody.term
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/suite-store/settled'].post
  update:
    x-apievangelist-phrasing:
      intent: Receive a suite store settlement webhook
      effect: write
      questions:
      - What happens when a suite store order settles?
      - Is the suite store settlement webhook safe to redeliver?
      instructions:
      - text: Deliver a signed settlement webhook to the suite store.
      - text: Post the suite order settlement event with its HMAC signature.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/suite-store/order/{token}/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Bind a paid suite order to agent DIDs
      effect: write
      questions:
      - How do I mint my Agent Mesh licence after paying?
      - Can I rebind my licence to different agent DIDs if I lose a key?
      instructions:
      - text: Activate suite order {token} for agent DIDs {agent_dids}.
        slots:
          token: path.token
          agent_dids: requestBody.agent_dids
      - text: Bind order {token}'s licence to DIDs {agent_dids}.
        slots:
          token: path.token
          agent_dids: requestBody.agent_dids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/suite-store/order/{token}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a suite store order's status
      effect: read
      questions:
      - Has my suite store order been paid and fulfilled?
      - Where can I check a suite order's progress?
      instructions:
      - text: Check the status of suite order {token}.
        slots:
          token: path.token
      - text: Show whether suite store order {token} is fulfilled.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'