Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for llm-api Chat API

7 actions 7 updates phrasing extends openapi/treasure-data-chat-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 7

$.info

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

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

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

$.paths['/api/chats/{id}/continue'].post

$.paths['/api/chats/{id}/download_files'].post

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

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 Chat API
  version: 1.0.0
extends: openapi/treasure-data-chat-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: 6
- target: $.paths['/api/chats'].get
  update:
    x-apievangelist-phrasing:
      intent: List agent chats
      effect: read
      questions:
      - Which conversations have I had with my agents?
      - Can I list only chats that produced artifacts, or chats in one project?
      instructions:
      - text: List my agent chats.
      - text: 'List chats in project {project_id} that have artifacts: {has_artifacts}.'
        slots:
          project_id: query.filter[project_id]
          has_artifacts: query.filter[has_artifacts]
      - text: List chats from chat interface {chat_interface_id} sorted by {sort}.
        slots:
          chat_interface_id: query.filter[chat_interface_id]
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/chats'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a new agent chat
      effect: write
      questions:
      - Can I open a new conversation with an agent?
      - What does it take to start a chat session programmatically?
      instructions:
      - text: Start a new chat with {data}.
        slots:
          data: requestBody.data
      - text: Open an agent chat using payload {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/chats/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agent chat
      effect: read
      questions:
      - Can I look up the details of one chat session?
      - Which agent and status does a given chat have?
      instructions:
      - text: Show chat {id}.
        slots:
          id: path.id
      - text: Get the details of chat session {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/chats/{id}/continue'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a follow-up message in a chat
      effect: write
      questions:
      - Can I keep talking to an agent in an existing chat?
      - Is it possible to attach files to a follow-up chat message?
      instructions:
      - text: Continue chat {id} with the message {input}.
        slots:
          id: path.id
          input: requestBody.input
      - text: Reply in chat {id} with {input} and attachments {attachments}.
        slots:
          id: path.id
          input: requestBody.input
          attachments: requestBody.attachments
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/chats/{id}/download_files'].post
  update:
    x-apievangelist-phrasing:
      intent: Download files from a chat
      effect: read
      questions:
      - Can I download the files an agent chat generated?
      - Is there a way to fetch only chat files under a certain prefix?
      instructions:
      - text: Download the files from chat {id} using method {method}.
        slots:
          id: path.id
          method: requestBody.method
      - text: Download files with prefix {prefix} from chat {id} via {method}.
        slots:
          prefix: requestBody.prefix
          id: path.id
          method: requestBody.method
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/chats/{id}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a chat's message history
      effect: read
      questions:
      - What was said earlier in an agent conversation?
      - Can I retrieve the full transcript of a chat?
      instructions:
      - text: Show the message history of chat {id}.
        slots:
          id: path.id
      - text: Get the full transcript of chat {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'