Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for llm-api Chat Attachment API

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

$.info

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

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

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

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

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 Attachment API
  version: 1.0.0
extends: openapi/treasure-data-chatattachment-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: 4
- target: $.paths['/api/chat_attachments'].get
  update:
    x-apievangelist-phrasing:
      intent: List chat attachments
      effect: read
      questions:
      - Which files were attached to my agent chats?
      - Can I list attachments of one chat or of one attachment type?
      instructions:
      - text: List attachments for chat {chat_id}.
        slots:
          chat_id: query.filter[chat_id]
      - text: List chat attachments of type {attachment_type} sorted by {sort}.
        slots:
          attachment_type: query.filter[attachment_type]
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/chat_attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a chat attachment
      effect: write
      questions:
      - Can I attach a file for an agent to use in a chat?
      - What does creating a chat attachment require?
      instructions:
      - text: Create a chat attachment with {data}.
        slots:
          data: requestBody.data
      - text: Upload an attachment for a chat using payload {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/chat_attachments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a chat attachment
      effect: read
      questions:
      - Can I look up a single chat attachment by its ID?
      - What details are stored about one file attached to a chat?
      instructions:
      - text: Show chat attachment {id}.
        slots:
          id: path.id
      - text: Get the details of attachment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/chat_attachments/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a chat attachment
      effect: destructive
      questions:
      - Can I remove a file I attached to a chat?
      - What deletes a single chat attachment?
      instructions:
      - text: Delete chat attachment {id}.
        slots:
          id: path.id
      - text: Remove attachment {id} from its chat.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'