API Evangelist conversational phrasing for ElevenLabs API Documentation Conversational AI API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ElevenLabs API Documentation Conversational AI API
  version: 1.0.0
extends: openapi/elevenlabs-conversational-ai-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: 7
- target: $.paths['/v1/convai/knowledge-base/crawl'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent knowledge base crawl jobs
      effect: read
      questions:
      - Which website crawl jobs are running or recently finished for my agents' knowledge base?
      - Can I include specific older crawl jobs in the list?
      instructions:
      - text: List my ongoing and recent crawl jobs.
      - text: Show crawl jobs, also including job IDs {include_job_ids}.
        slots:
          include_job_ids: query.include_job_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/knowledge-base/crawl'].post
  update:
    x-apievangelist-phrasing:
      intent: Crawl a website into the knowledge base
      effect: write
      questions:
      - How do I import a whole documentation site into my agent's knowledge base?
      - Can I limit crawl depth and page count or only include URLs matching a pattern?
      - Is it possible to keep crawled pages auto-synced as the site changes?
      instructions:
      - text: Crawl {url} into the knowledge base.
        slots:
          url: requestBody.url
      - text: Crawl {url} to depth {max_depth} with at most {max_pages} pages.
        slots:
          url: requestBody.url
          max_depth: requestBody.max_depth
          max_pages: requestBody.max_pages
      - text: Crawl only pages matching {pattern} under {url} with auto-sync {enable_auto_sync}.
        slots:
          pattern: requestBody.pattern
          url: requestBody.url
          enable_auto_sync: requestBody.enable_auto_sync
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/knowledge-base/crawl/{crawl_job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a crawl job's progress
      effect: read
      questions:
      - How far along is my knowledge base crawl?
      - Did a specific crawl job finish successfully?
      instructions:
      - text: Show progress of crawl job {crawl_job_id}.
        slots:
          crawl_job_id: path.crawl_job_id
      - text: Get the status of crawl {crawl_job_id}.
        slots:
          crawl_job_id: path.crawl_job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/knowledge-base/crawl/{crawl_job_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a crawl job and discard its documents
      effect: destructive
      questions:
      - Can I stop a crawl that is pulling in the wrong pages?
      - Does cancelling a crawl delete the documents it already created?
      instructions:
      - text: Cancel crawl job {crawl_job_id}.
        slots:
          crawl_job_id: path.crawl_job_id
      - text: Stop crawl {crawl_job_id} and delete everything it added.
        slots:
          crawl_job_id: path.crawl_job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/knowledge-base/folder'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a knowledge base folder
      effect: write
      questions:
      - Can I organize knowledge base documents into folders?
      - How do I make a subfolder inside an existing knowledge base folder?
      instructions:
      - text: Create a knowledge base folder named {name}.
        slots:
          name: requestBody.name
      - text: Make folder {name} inside folder {parent_folder_id}.
        slots:
          name: requestBody.name
          parent_folder_id: requestBody.parent_folder_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/knowledge-base/{document_id}/move'].post
  update:
    x-apievangelist-phrasing:
      intent: Move one knowledge base document to a folder
      effect: write
      questions:
      - How do I move a single document into another knowledge base folder?
      - What happens if I move a document without naming a destination folder?
      instructions:
      - text: Move document {document_id} to folder {move_to}.
        slots:
          document_id: path.document_id
          move_to: requestBody.move_to
      - text: Move knowledge base item {document_id} back to the root folder.
        slots:
          document_id: path.document_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/knowledge-base/bulk-move'].post
  update:
    x-apievangelist-phrasing:
      intent: Move many knowledge base items at once
      effect: write
      questions:
      - Can I move a batch of documents and folders together?
      - Is there a bulk way to reorganize my knowledge base?
      instructions:
      - text: Move documents {document_ids} to folder {move_to}.
        slots:
          document_ids: requestBody.document_ids
          move_to: requestBody.move_to
      - text: Bulk-move items {document_ids} to the root of the knowledge base.
        slots:
          document_ids: requestBody.document_ids
      method: generated
      generated: '2026-09-26'