# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for knowledge > sources API
  version: 1.0.0
extends: openapi/ada-knowledge-sources-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/knowledge/sources/'].get
  update:
    x-apievangelist-phrasing:
      intent: List knowledge sources
      effect: read
      questions:
      - Which knowledge sources feed my AI Agent?
      - Can I check whether a knowledge source is still being deleted?
      instructions:
      - text: List all my knowledge sources.
      - text: Show each knowledge source and its status.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/knowledge/sources/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a knowledge source
      effect: write
      questions:
      - How do I set up a new knowledge source for articles I'll upload?
      - Can I store my own metadata on a knowledge source?
      instructions:
      - text: Create knowledge source {id} named {name}.
        slots:
          id: requestBody.id
          name: requestBody.name
      - text: Add a knowledge source {id} called {name} with metadata {metadata}.
        slots:
          id: requestBody.id
          name: requestBody.name
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/knowledge/sources/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a knowledge source and its articles
      effect: destructive
      questions:
      - How do I remove a whole knowledge source along with its articles?
      - What does a delete_failed status on a knowledge source mean?
      instructions:
      - text: Delete knowledge source {id} and all its articles.
        slots:
          id: path.id
      - text: Retry deleting knowledge source {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/knowledge/sources/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or edit a knowledge source
      effect: write
      questions:
      - How do I rename an existing knowledge source?
      - Can I change the metadata on a knowledge source after creating it?
      instructions:
      - text: Rename knowledge source {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update the metadata of knowledge source {id} to {metadata}.
        slots:
          id: path.id
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'