Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for llm-api Prompt API

6 actions 6 updates phrasing extends openapi/treasure-data-prompt-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/api/prompts'].get

$.paths['/api/prompts'].post

$.paths['/api/prompts/{id}'].get

$.paths['/api/prompts/{id}'].delete

$.paths['/api/prompts/{id}'].patch

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 llm-api Prompt API
  version: 1.0.0
extends: openapi/treasure-data-prompt-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: 5
- target: $.paths['/api/prompts'].get
  update:
    x-apievangelist-phrasing:
      intent: List prompts
      effect: read
      questions:
      - Which prompts are saved for my Treasure Data AI agents?
      - Can I sort my saved prompts?
      instructions:
      - text: List all my saved prompts.
      - text: List prompts sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/prompts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a prompt
      effect: write
      questions:
      - How do I save a new reusable prompt?
      - What do I send to create a prompt?
      instructions:
      - text: Create a prompt with {data}.
        slots:
          data: requestBody.data
      - text: Save a new prompt for my agents using {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/prompts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a prompt
      effect: read
      questions:
      - What does a specific saved prompt contain?
      - Can I fetch one prompt by its ID?
      instructions:
      - text: Show prompt {id}.
        slots:
          id: path.id
      - text: Fetch the text and settings of prompt {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/prompts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a prompt
      effect: destructive
      questions:
      - How do I remove a prompt I no longer use?
      - Is deleting a prompt permanent?
      instructions:
      - text: Delete prompt {id}.
        slots:
          id: path.id
      - text: Remove the outdated prompt {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/prompts/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a prompt
      effect: write
      questions:
      - Can I edit the wording of an existing prompt?
      - What parts of a saved prompt can I change?
      instructions:
      - text: Update prompt {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Edit the existing prompt {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'