Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for llm-api Chat Interface API

6 actions 6 updates phrasing extends openapi/treasure-data-chatinterface-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/chat_interfaces'].get
$.paths['/api/chat_interfaces'].post
$.paths['/api/chat_interfaces/{id}'].get
$.paths['/api/chat_interfaces/{id}'].delete
$.paths['/api/chat_interfaces/{id}'].patch

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 llm-api Chat Interface API
  version: 1.0.0
extends: openapi/treasure-data-chatinterface-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/chat_interfaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List chat interfaces
      effect: read
      questions:
      - Which chat interfaces have been published for my agents?
      - Can I find chat interfaces by name or by project?
      instructions:
      - text: List all chat interfaces.
      - text: Find chat interfaces named {name} in project {project_id}.
        slots:
          name: query.filter[name]
          project_id: query.filter[project_id]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/chat_interfaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a chat interface
      effect: write
      questions:
      - Can I put a chat interface in front of an agent so others can use it?
      - What is needed to create a chat interface?
      instructions:
      - text: Create a chat interface with {data}.
        slots:
          data: requestBody.data
      - text: Set up a new chat interface from payload {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/chat_interfaces/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a chat interface
      effect: read
      questions:
      - How is one chat interface configured?
      - Can I look up a chat interface by its ID?
      instructions:
      - text: Show chat interface {id}.
        slots:
          id: path.id
      - text: Get the configuration of chat interface {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/chat_interfaces/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a chat interface
      effect: destructive
      questions:
      - Can I take down a chat interface nobody uses?
      - What removes a chat interface permanently?
      instructions:
      - text: Delete chat interface {id}.
        slots:
          id: path.id
      - text: Remove chat interface {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/chat_interfaces/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a chat interface
      effect: write
      questions:
      - Can I rename or reconfigure an existing chat interface?
      - Which chat interface settings can be changed?
      instructions:
      - text: Update chat interface {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Change the settings of chat interface {id} to {data}.
        slots:
          id: path.id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'