# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for AI Knowledge API
  version: 1.0.0
extends: openapi/vendasta-knowledge-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: 5
- target: $.paths['/v1/knowledge/file-upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a signed URL to upload a knowledge file
      effect: write
      questions:
      - How do I upload a file to an AI Employee's knowledge base?
      - What is the write rate limit for knowledge uploads?
      instructions:
      - text: Get an upload URL for file {name} of type {type}.
        slots:
          name: requestBody.fileName
          type: requestBody.contentType
      - text: Create a knowledge file upload for {name} ({type}) in account {account}.
        slots:
          name: requestBody.fileName
          type: requestBody.contentType
          account: requestBody.accountGroupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/knowledge/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List knowledge sources
      effect: read
      questions:
      - Which knowledge sources are in an account's knowledge base?
      - Can I see only the knowledge linked to one AI Employee?
      instructions:
      - text: List knowledge sources for account {account}.
        slots:
          account: requestBody.accountGroupId
      - text: List the knowledge linked to AI Employee {assistant}.
        slots:
          assistant: requestBody.assistantId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/knowledge/remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove or unlink a knowledge source
      effect: destructive
      questions:
      - Can I delete a knowledge source from the knowledge base?
      - Is there a way to unlink knowledge from an AI Employee without deleting it?
      instructions:
      - text: Delete knowledge source {source}.
        slots:
          source: requestBody.knowledgeSourceId
      - text: Unlink knowledge source {source} from AI Employees {unlink}.
        slots:
          source: requestBody.knowledgeSourceId
          unlink: requestBody.unlink
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/knowledge/status'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a knowledge source's processing status
      effect: read
      questions:
      - Has my uploaded knowledge finished processing yet?
      - What is the ingestion status of a single knowledge source?
      instructions:
      - text: Get the processing status of knowledge source {source}.
        slots:
          source: requestBody.knowledgeSourceId
      - text: Check whether knowledge {source} in account {account} is ready.
        slots:
          source: requestBody.knowledgeSourceId
          account: requestBody.accountGroupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/knowledge/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a knowledge source
      effect: write
      questions:
      - Can I add text content to an AI Employee's knowledge base?
      - Can I update an existing knowledge source instead of creating a duplicate?
      instructions:
      - text: Add knowledge named {name} with content {content} to account {account}.
        slots:
          name: requestBody.name
          content: requestBody.content
          account: requestBody.accountGroupId
      - text: Update knowledge source {source} with content {content}.
        slots:
          source: requestBody.knowledgeSourceId
          content: requestBody.content
      - text: Create knowledge {name} and link it to AI Employee {assistant}.
        slots:
          name: requestBody.name
          assistant: requestBody.assistantId
      method: generated
      generated: '2026-10-01'