Ada · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Knowledge End Users API

5 actions 5 updates phrasing extends openapi/ada-end-users-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 5

$.info

$.paths['/v2/end-users/{end_user_id}'].get

$.paths['/v2/end-users/{end_user_id}'].patch

$.paths['/v2/end-users/'].get

$.paths['/v2/end-users/'].post

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 Knowledge End Users API
  version: 1.0.0
extends: openapi/ada-end-users-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['/v2/end-users/{end_user_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an end user by Ada id
      effect: read
      questions:
      - How do I view the profile of one end user using their Ada id?
      - What profile details does Ada hold for a specific end user?
      instructions:
      - text: Get end user {end_user_id}.
        slots:
          end_user_id: path.end_user_id
      - text: Show the profile of Ada end user {end_user_id}.
        slots:
          end_user_id: path.end_user_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/end-users/{end_user_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an end user's profile
      effect: write
      questions:
      - How do I change the profile details of an existing end user?
      - Can I remove or change the external id on an end user who already exists?
      instructions:
      - text: Update end user {end_user_id} with profile {profile}.
        slots:
          end_user_id: path.end_user_id
          profile: requestBody.profile
      - text: Set external id {external_id} on end user {end_user_id} and update profile {profile}.
        slots:
          external_id: requestBody.external_id
          end_user_id: path.end_user_id
          profile: requestBody.profile
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/end-users/'].get
  update:
    x-apievangelist-phrasing:
      intent: List end users or find one by external id
      effect: read
      questions:
      - How can I page through all the end users my AI Agent has talked to?
      - Can I find an end user using our CRM contact id instead of Ada's id?
      instructions:
      - text: List my end users.
      - text: Find the end user whose external id is {external_id}.
        slots:
          external_id: query.external_id
      - text: Show {limit} end users starting after {cursor}.
        slots:
          limit: query.limit
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/end-users/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an end user before a conversation
      effect: write
      questions:
      - How do I give the AI Agent a customer's context before the first message?
      - What happens to an end user I create but never attach to a conversation?
      instructions:
      - text: Create an end user with external id {external_id}.
        slots:
          external_id: requestBody.external_id
      - text: Register a new end user with external id {external_id} and profile {profile}.
        slots:
          external_id: requestBody.external_id
          profile: requestBody.profile
      method: generated
      generated: '2026-10-01'