Ada · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Knowledge Channels API

4 actions 4 updates phrasing extends openapi/ada-channels-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Ada's API. It is a proposal applied on top of the contract, not a document Ada publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/v2/channels/'].get
$.paths['/v2/channels/'].post
$.paths['/v2/channels/{channel_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 Knowledge Channels API
  version: 1.0.0
extends: openapi/ada-channels-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/v2/channels/'].get
  update:
    x-apievangelist-phrasing:
      intent: List messaging channels
      effect: read
      questions:
      - Which channels are set up for my AI Agent?
      - Can I list only the voice channels or only the messaging channels?
      - How many channels come back per page when I list them?
      instructions:
      - text: List all channels of type {type}.
        slots:
          type: query.type
      - text: Show me {type} channels with {modality} modality.
        slots:
          type: query.type
          modality: query.modality
      - text: Page through {type} channels starting after {cursor}.
        slots:
          type: query.type
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/channels/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom channel
      effect: write
      questions:
      - How do I add a new custom channel for my Ada AI Agent?
      - Is there a daily limit on how many channels I can create?
      - Can I declare what a new channel's surface is able to render when I create it?
      instructions:
      - text: Create a channel named {name} with {modality} modality described as {description}.
        slots:
          name: requestBody.name
          modality: requestBody.modality
          description: requestBody.description
      - text: Set up a new {modality} channel called {name}, description {description}, with capabilities {capabilities}.
        slots:
          modality: requestBody.modality
          name: requestBody.name
          description: requestBody.description
          capabilities: requestBody.capabilities
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/channels/{channel_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a custom channel's capabilities
      effect: write
      questions:
      - How do I change what an existing custom channel can render?
      - Can native channels have their capabilities edited, or only custom ones?
      instructions:
      - text: Update the capabilities of channel {channel_id} to {capabilities}.
        slots:
          channel_id: path.channel_id
          capabilities: requestBody.capabilities
      - text: Turn on rich rendering for existing channel {channel_id} by setting capabilities {capabilities}.
        slots:
          channel_id: path.channel_id
          capabilities: requestBody.capabilities
      method: generated
      generated: '2026-09-26'