AlgoVoi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Algovoi Co Uk A2a API

17 actions 17 updates phrasing extends openapi/algovoi-co-uk-a2a-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 17 · first 16 shown; the file carries all of them

$.info
$.paths['/a2a'].get
$.paths['/a2a'].post
$.paths['/ext/scoped-authorization-receipts/v1'].get
$.paths['/ext/scoped-authorization-receipts/v1'].head
$.paths['/extendedAgentCard'].get
$.paths['/message:send'].post
$.paths['/message:stream'].post
$.paths['/tasks/{task_id}/pushNotificationConfigs/{config_id}'].get
$.paths['/tasks/{task_id}/pushNotificationConfigs/{config_id}'].delete
$.paths['/tasks/{task_id}/pushNotificationConfigs'].get
$.paths['/tasks/{task_id}/pushNotificationConfigs'].post
$.paths['/tasks/{task_id}'].get
$.paths['/tasks/{task_id}:cancel'].post
$.paths['/tasks'].get
$.paths['/a2a/jsonrpc'].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 A2a API
  version: 1.0.0
extends: openapi/algovoi-co-uk-a2a-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: 16
- target: $.paths['/a2a'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pointer to the A2A POST transport
      effect: read
      questions:
      - What does a GET on the A2A endpoint return if the real transport is POST?
      - Is there a hint telling my agent how to reach the AlgoVoi A2A interface?
      instructions:
      - text: Fetch the A2A endpoint hint to see how to talk to the agent.
      - text: Probe the A2A path with a GET to learn the correct transport.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/a2a'].post
  update:
    x-apievangelist-phrasing:
      intent: Post a request to the A2A endpoint
      effect: write
      questions:
      - Can I POST an agent-to-agent request directly to the base A2A path?
      - Where does the plain A2A POST transport live?
      instructions:
      - text: Post my agent request to the base A2A endpoint.
      - text: Send an agent-to-agent call to the root A2A transport.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ext/scoped-authorization-receipts/v1'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the scoped authorization receipts profile
      effect: read
      questions:
      - What is the scoped authorization receipts extension profile for A2A?
      - Where can I read the v1 scoped-authorization-receipts extension document?
      instructions:
      - text: Get the scoped authorization receipts v1 profile document.
      - text: Download the A2A scoped-authorization-receipts extension spec.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ext/scoped-authorization-receipts/v1'].head
  update:
    x-apievangelist-phrasing:
      intent: Check the receipts profile exists (HEAD)
      effect: read
      questions:
      - Can I check the scoped receipts profile is published without downloading the body?
      - Does a HEAD request on the receipts extension URL confirm it is live?
      instructions:
      - text: Send a HEAD request to confirm the scoped receipts extension is available.
      - text: Check headers only for the scoped-authorization-receipts profile.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/extendedAgentCard'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the authenticated extended agent card
      effect: read
      questions:
      - How do I see my tenant-specific endpoints in the AlgoVoi agent card?
      - What extra details does the authenticated extended agent card add to the public one?
      instructions:
      - text: Fetch the extended agent card for tenant {tenant_id}.
        slots:
          tenant_id: query.tenant_id
      - text: Get my authenticated agent card with tenant endpoint info.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/message:send'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a message to the payment agent
      effect: write
      questions:
      - How do I ask the payment agent to create a checkout or verify a payment over A2A?
      - Which payment skills can I invoke by sending the agent a message?
      - What comes back when I send a message, a finished task?
      instructions:
      - text: 'Send the payment agent this message: {message}.'
        slots:
          message: requestBody.message
      - text: Message the agent {message} to run the create-checkout skill.
        slots:
          message: requestBody.message
      method: generated
      generated: '2026-10-01'
- target: $.paths['/message:stream'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a streamed agent reply (unsupported)
      effect: write
      questions:
      - Does the AlgoVoi agent support streaming message responses?
      - What error do I get if I try the streaming message binding?
      instructions:
      - text: Try streaming a message to the agent and report the unsupported-operation error.
      - text: Call the message stream endpoint to confirm streaming is disabled.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{task_id}/pushNotificationConfigs/{config_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one push notification config for a task
      effect: read
      questions:
      - Can I read a specific push notification configuration on a task?
      - Are task push notifications supported at all by this agent?
      instructions:
      - text: Get push config {config_id} on task {task_id}.
        slots:
          config_id: path.config_id
          task_id: path.task_id
      - text: Read single notification setting {config_id} for task {task_id}.
        slots:
          config_id: path.config_id
          task_id: path.task_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{task_id}/pushNotificationConfigs/{config_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a push notification config from a task
      effect: destructive
      questions:
      - How do I remove a push notification config from a task?
      - What does deleting a task notification config return when push is unsupported?
      instructions:
      - text: Delete push config {config_id} from task {task_id}.
        slots:
          config_id: path.config_id
          task_id: path.task_id
      - text: Remove notification setting {config_id} on task {task_id}.
        slots:
          config_id: path.config_id
          task_id: path.task_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{task_id}/pushNotificationConfigs'].get
  update:
    x-apievangelist-phrasing:
      intent: List push notification configs for a task
      effect: read
      questions:
      - Which push notification configs are set on a task?
      - Can I list all webhook notification settings for an A2A task?
      instructions:
      - text: List the push notification configs on task {task_id}.
        slots:
          task_id: path.task_id
      - text: Show every notification webhook setting for task {task_id}.
        slots:
          task_id: path.task_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{task_id}/pushNotificationConfigs'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a push notification config to a task
      effect: write
      questions:
      - Can I register a webhook to be notified when a task changes?
      - What happens if I try to set up push notifications on a task here?
      instructions:
      - text: Create a push notification config on task {task_id}.
        slots:
          task_id: path.task_id
      - text: Register a notification webhook for updates to task {task_id}.
        slots:
          task_id: path.task_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{task_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current state of an agent task
      effect: read
      questions:
      - What state is my payment agent task in now?
      - Can I look up an A2A task's result by its id?
      instructions:
      - text: Get task {task_id} and its current state.
        slots:
          task_id: path.task_id
      - text: Show me the result of agent task {task_id}.
        slots:
          task_id: path.task_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{task_id}:cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a submitted or working task
      effect: destructive
      questions:
      - Can I cancel an agent task that has already completed?
      - Which task states can still be cancelled?
      instructions:
      - text: Cancel agent task {task_id}.
        slots:
          task_id: path.task_id
      - text: Stop task {task_id} if it is still submitted or working.
        slots:
          task_id: path.task_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent tasks in this session
      effect: read
      questions:
      - Which agent tasks have I run in this session?
      - How long are recent tasks kept before they drop out of the list?
      instructions:
      - text: List my recent agent tasks.
      - text: Show tasks from the last ten minutes for tenant {tenant_id}.
        slots:
          tenant_id: query.tenant_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/a2a/jsonrpc'].post
  update:
    x-apievangelist-phrasing:
      intent: Call the agent over JSON-RPC 2.0
      effect: write
      questions:
      - Does the AlgoVoi agent offer a JSON-RPC 2.0 interface?
      - Where do I send JSON-RPC calls advertised in the agent card?
      instructions:
      - text: Send a JSON-RPC 2.0 request to the payment agent.
      - text: Call the agent's JSONRPC interface for tenant {tenant_id}.
        slots:
          tenant_id: query.tenant_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/a2a/gibberlink'].post
  update:
    x-apievangelist-phrasing:
      intent: Post to the Gibberlink A2A endpoint
      effect: write
      questions:
      - Is there a Gibberlink-mode endpoint for agent-to-agent talk?
      - Where do agents send Gibberlink messages?
      instructions:
      - text: Send a Gibberlink message to the agent.
      - text: Post to the Gibberlink endpoint for tenant {tenant_id}.
        slots:
          tenant_id: query.tenant_id
      method: generated
      generated: '2026-10-01'