TextQL · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Textql.rpc.platform.Agent Service API

2 actions 2 updates phrasing extends openapi/textql-textql-rpc-platform-agentservice-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for TextQL's API. It is a proposal applied on top of the contract, not a document TextQL publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/v1/agents/webhook/trigger'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Textql.rpc.platform.Agent Service API
  version: 1.0.0
extends: openapi/textql-textql-rpc-platform-agentservice-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: 1
- target: $.paths['/v1/agents/webhook/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger an agent run from a webhook
      effect: write
      questions:
      - How do I kick off a TextQL agent run from an external webhook?
      - Can I pass a JSON payload into the agent when triggering it?
      instructions:
      - text: Trigger agent webhook {triggerId}.
        slots:
          triggerId: requestBody.triggerId
      - text: Fire trigger {triggerId} with payload {payload}.
        slots:
          triggerId: requestBody.triggerId
          payload: requestBody.payload
      method: generated
      generated: '2026-10-01'