TaskHawk Systems · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Taskhawktech Com Signup API

2 actions 2 updates phrasing extends openapi/taskhawktech-com-signup-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for TaskHawk Systems's API. It is a proposal applied on top of the contract, not a document TaskHawk Systems publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/signup'].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 Taskhawktech Com Signup API
  version: 1.0.0
extends: openapi/taskhawktech-com-signup-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['/signup'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a trial API key for an agent
      effect: write
      questions:
      - How do I get a trial API key without a credit card or email?
      - What are the call and rate limits on the free trial key?
      - Can I record which broker agent referred me when signing up?
      instructions:
      - text: Sign up agent {agent_id} for a trial API key.
        slots:
          agent_id: requestBody.agent_id
      - text: Get a trial key for agent {agent_id} with recovery email {operator_email}.
        slots:
          agent_id: requestBody.agent_id
          operator_email: requestBody.operator_email
      - text: Register agent {agent_id} for a trial key, referred by broker {referred_by}.
        slots:
          agent_id: requestBody.agent_id
          referred_by: requestBody.referred_by
      method: generated
      generated: '2026-10-01'