Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for llm-api Agent API

6 actions 6 updates phrasing extends openapi/treasure-data-agent-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/agents'].get

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

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

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

$.paths['/api/agents/{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 Agent API
  version: 1.0.0
extends: openapi/treasure-data-agent-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/agents'].get
  update:
    x-apievangelist-phrasing:
      intent: List LLM agents
      effect: read
      questions:
      - Which AI agents have been set up in my account?
      - Can I sort my agents or include related records in the list?
      instructions:
      - text: List my agents.
      - text: List agents sorted by {sort}, including {include}.
        slots:
          sort: query.sort
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/agents'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an LLM agent
      effect: write
      questions:
      - What is needed to create a new AI agent?
      - Can I define an agent's prompt and model when I create it?
      instructions:
      - text: Create an agent with {data}.
        slots:
          data: requestBody.data
      - text: Set up a new agent from payload {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/agents/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an LLM agent
      effect: read
      questions:
      - How is one particular agent configured?
      - Can I look up an agent by its ID?
      instructions:
      - text: Show agent {id}.
        slots:
          id: path.id
      - text: Get the configuration of agent {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/agents/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an LLM agent
      effect: destructive
      questions:
      - Can I delete an agent I no longer need?
      - What happens to an agent when I remove it?
      instructions:
      - text: Delete agent {id}.
        slots:
          id: path.id
      - text: Remove agent {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/agents/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an LLM agent
      effect: write
      questions:
      - Can I change an existing agent's settings?
      - Which parts of an agent can be updated after creation?
      instructions:
      - text: Update agent {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Change the configuration of agent {id} to {data}.
        slots:
          id: path.id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'