# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ElevenLabs Conversational AI Knowledge Base API
  version: 1.0.0
extends: openapi/elevenlabs-knowledge-base-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: 4
- target: $.paths['/v1/convai/knowledge-base'].get
  update:
    x-apievangelist-phrasing:
      intent: List knowledge base documents
      effect: read
      questions:
      - Which documents are in my agents' knowledge base?
      - Can I see everything my conversational agents can reference?
      instructions:
      - text: List my knowledge base documents.
      - text: Show all documents available to my agents.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/knowledge-base'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a document to the knowledge base
      effect: write
      questions:
      - How do I give my voice agent a PDF to answer questions from?
      - Can I add a single web page as a knowledge source?
      instructions:
      - text: Upload {file} to the knowledge base as {name}.
        slots:
          file: requestBody.file
          name: requestBody.name
      - text: Add the web page {url} to the knowledge base.
        slots:
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/knowledge-base/{document_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a knowledge base document
      effect: destructive
      questions:
      - How do I remove an outdated document from the knowledge base?
      - Can I delete a knowledge base document agents still use?
      instructions:
      - text: Delete knowledge base document {document_id}.
        slots:
          document_id: path.document_id
      - text: Remove {document_id} from the knowledge base.
        slots:
          document_id: path.document_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/knowledge-base/{document_id}/dependent-agents'].get
  update:
    x-apievangelist-phrasing:
      intent: See which agents use a knowledge base document
      effect: read
      questions:
      - Which agents depend on this knowledge base document?
      - Before deleting a document, how can I tell which agents would be affected?
      instructions:
      - text: List agents that depend on document {document_id}.
        slots:
          document_id: path.document_id
      - text: Show which agents reference knowledge base document {document_id}.
        slots:
          document_id: path.document_id
      method: generated
      generated: '2026-09-26'