Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for llm-api Integration API

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

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

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

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

$.paths['/api/integrations/{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 Integration API
  version: 1.0.0
extends: openapi/treasure-data-integration-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/integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List AI agent integrations
      effect: read
      questions:
      - Which integrations are set up for my Treasure Data AI agents?
      - Can I sort the list of integrations?
      instructions:
      - text: List all my agent integrations.
      - text: List integrations sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an integration
      effect: write
      questions:
      - How do I connect a new integration to my AI agents?
      - What does a request to create an integration need?
      instructions:
      - text: Create a new integration with {data}.
        slots:
          data: requestBody.data
      - text: 'Set up an agent integration using these settings: {data}.'
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/integrations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an integration
      effect: read
      questions:
      - What are the details of one specific integration?
      - Can I fetch a single integration by ID?
      instructions:
      - text: Show integration {id}.
        slots:
          id: path.id
      - text: Fetch the settings of integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/integrations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an integration
      effect: destructive
      questions:
      - How do I disconnect and remove an integration?
      - Is removing an integration reversible?
      instructions:
      - text: Delete integration {id}.
        slots:
          id: path.id
      - text: Remove the integration {id} from my agents.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/integrations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an integration
      effect: write
      questions:
      - Can I change the configuration of an existing integration?
      - What can be edited on an integration after it is created?
      instructions:
      - text: Update integration {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Edit the settings of existing integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'