# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Partners AI Customization Documents API
  version: 1.0.0
extends: openapi/activecampaign-ai-customization-documents-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: 6
- target: $.paths['/api/ai-customizations/v1/profiles/{profile_id}/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List documents on an AI profile
      effect: read
      questions:
      - Which reference documents are uploaded to an AI customization profile?
      - Can I page through the documents attached to a profile?
      instructions:
      - text: List documents on AI profile {profile_id}.
        slots:
          profile_id: path.profile_id
      - text: Show page {page} of documents for profile {profile_id}, {limit} per page.
        slots:
          page: query.page
          profile_id: path.profile_id
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-customizations/v1/profiles/{profile_id}/documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a document to an AI profile
      effect: write
      questions:
      - How do I give the AI my brand guidelines as a document?
      - Can I tag and describe a file when uploading it to a profile?
      instructions:
      - text: Upload {file} to AI profile {profile_id}.
        slots:
          file: requestBody.file
          profile_id: path.profile_id
      - text: Upload {file} to profile {profile_id} described as {description}.
        slots:
          file: requestBody.file
          profile_id: path.profile_id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-customizations/v1/profiles/{profile_id}/documents/{document_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an AI profile document
      effect: read
      questions:
      - Where do I see the details of one document on an AI profile?
      - Is a particular uploaded document currently enabled?
      instructions:
      - text: Show document {document_id} on profile {profile_id}.
        slots:
          document_id: path.document_id
          profile_id: path.profile_id
      - text: Get the tags and status of document {document_id} in profile {profile_id}.
        slots:
          document_id: path.document_id
          profile_id: path.profile_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-customizations/v1/profiles/{profile_id}/documents/{document_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an AI profile document
      effect: destructive
      questions:
      - Can I remove an outdated document from an AI profile?
      - What deletes a reference file the AI should no longer use?
      instructions:
      - text: Delete document {document_id} from profile {profile_id}.
        slots:
          document_id: path.document_id
          profile_id: path.profile_id
      - text: Remove the outdated file {document_id} from AI profile {profile_id}.
        slots:
          document_id: path.document_id
          profile_id: path.profile_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-customizations/v1/profiles/{profile_id}/documents/{document_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Enable, disable or retag an AI document
      effect: write
      questions:
      - Can I turn off a document so the AI ignores it without deleting it?
      - How do I change the tags or description on an uploaded document?
      instructions:
      - text: Set document {document_id} on profile {profile_id} enabled to {is_enabled}.
        slots:
          document_id: path.document_id
          profile_id: path.profile_id
          is_enabled: requestBody.is_enabled
      - text: Retag document {document_id} in profile {profile_id} with {tags}, enabled {is_enabled}.
        slots:
          document_id: path.document_id
          profile_id: path.profile_id
          tags: requestBody.tags
          is_enabled: requestBody.is_enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-customizations/v1/profiles/{profile_id}/documents/{document_id}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a download link for an AI document
      effect: read
      questions:
      - How can I download the original file I uploaded to an AI profile?
      - Is there a temporary link to fetch a profile document?
      instructions:
      - text: Get a download URL for document {document_id} on profile {profile_id}.
        slots:
          document_id: path.document_id
          profile_id: path.profile_id
      - text: Give me a presigned link to download file {document_id} from profile {profile_id}.
        slots:
          document_id: path.document_id
          profile_id: path.profile_id
      method: generated
      generated: '2026-09-26'