# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Files API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-files-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: 19
- target: $.paths['/api/files/images/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import images from an attachment into storage
      effect: write
      questions:
      - Can I pull the images out of an attachment into my creative image storage?
      - Is there a minimum edge size filter when importing images from a source file?
      instructions:
      - text: Import all images from source {source} into my storage.
        slots:
          source: requestBody.source
      - text: Import images {imageRefs} from {source}, skipping any smaller than {minEdgePx} pixels.
        slots:
          imageRefs: requestBody.imageRefs
          source: requestBody.source
          minEdgePx: requestBody.minEdgePx
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/files/upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a creative image
      effect: write
      questions:
      - How do I upload an image to use in my email creatives?
      - What is the size limit for creative image uploads?
      instructions:
      - text: Upload {file} as a creative image.
        slots:
          file: requestBody.file
      - text: Add image {file} to my creative images.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/files/images'].get
  update:
    x-apievangelist-phrasing:
      intent: List uploaded creative images
      effect: read
      questions:
      - Which creative images have I already uploaded?
      - Can I see all images available for my email creatives?
      instructions:
      - text: List my uploaded creative images.
      - text: Show every image in my creative image library.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/files/images/{filename}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a creative image
      effect: destructive
      questions:
      - Can I remove an uploaded creative image I no longer need?
      - Is deleting a creative image limited to my own tenant's files?
      instructions:
      - text: Delete creative image {filename}.
        slots:
          filename: path.filename
      - text: Remove the creative image file {filename}.
        slots:
          filename: path.filename
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/files/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List tenant assets like signatures
      effect: read
      questions:
      - Where can I see the signature and PDF photo assets stored for my account?
      - What tenant assets do I have uploaded?
      instructions:
      - text: List my tenant assets.
      - text: Show the signature and PDF photo files in my assets.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/files/assets'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a signature or PDF photo asset
      effect: write
      questions:
      - How do I upload a signature image or a photo for personal PDFs?
      - What is the size limit for a tenant asset upload?
      instructions:
      - text: Upload {file} as a tenant asset.
        slots:
          file: requestBody.file
      - text: Add signature file {file} to my assets.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/files/assets/quota'].get
  update:
    x-apievangelist-phrasing:
      intent: Check tenant asset storage quota
      effect: read
      questions:
      - How much of my asset storage quota have I used?
      - What is my remaining space for signatures and PDF photos?
      instructions:
      - text: Show my tenant asset storage usage and quota.
      - text: Check how much asset storage I have left.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/files/assets/{filename}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tenant asset
      effect: destructive
      questions:
      - Can I delete an old signature or photo asset?
      - Will removing a tenant asset free up asset quota?
      instructions:
      - text: Delete tenant asset {filename}.
        slots:
          filename: path.filename
      - text: Remove asset file {filename} from my account.
        slots:
          filename: path.filename
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List file attachments on a contact, company or lead
      effect: read
      questions:
      - Which files are attached to a particular contact?
      - Can I see all attachments on a company or a CRM lead?
      instructions:
      - text: List files attached to contact {contactId}.
        slots:
          contactId: query.contactId
      - text: Show attachments for company {companyId}.
        slots:
          companyId: query.companyId
      - text: List files on lead {leadId}.
        slots:
          leadId: query.leadId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a file to a contact, company or lead
      effect: write
      questions:
      - How do I attach a document to a contact record?
      - What is the maximum size of a file attached to a lead or company?
      instructions:
      - text: Attach a file to contact {contactId}.
        slots:
          contactId: requestBody.contactId
      - text: Upload an attachment to lead {leadId}.
        slots:
          leadId: requestBody.leadId
      - text: Attach a document to company {companyId}.
        slots:
          companyId: requestBody.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/files/{id}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a file attachment
      effect: read
      questions:
      - How do I download a file that's attached to a contact or lead?
      - Can I get the actual bytes of a CRM attachment?
      instructions:
      - text: Download attachment {id}.
        slots:
          id: path.id
      - text: Fetch the file contents of attachment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/files/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a file attachment
      effect: destructive
      questions:
      - Can I delete an attachment from a contact or lead?
      - What happens when I remove a file attachment record?
      instructions:
      - text: Delete file attachment {id}.
        slots:
          id: path.id
      - text: Remove attachment {id} from its record.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/files/library/quota'].get
  update:
    x-apievangelist-phrasing:
      intent: Check library storage quota
      effect: read
      questions:
      - How much of my 500 MB files library have I used?
      - Is the library quota separate from the branding asset quota?
      instructions:
      - text: Show my files library storage usage.
      - text: Check how much space is left in my document library.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/files/library'].get
  update:
    x-apievangelist-phrasing:
      intent: List the files and links library
      effect: read
      questions:
      - Can I see all documents and links in my library for a given brief?
      - Can I search my library items by text or kind?
      instructions:
      - text: List library items for brief {briefId}.
        slots:
          briefId: query.briefId
      - text: Search my library for {search}.
        slots:
          search: query.search
      - text: Show library items attached to lead {leadId}.
        slots:
          leadId: query.leadId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/files/library'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a file or link to the library
      effect: write
      questions:
      - How do I add a PDF or slide deck to my document library?
      - Can I save a web link in the library instead of a file?
      - Which file types does the library accept?
      instructions:
      - text: Add {file} to my library titled {title}.
        slots:
          file: requestBody.file
          title: requestBody.title
      - text: Save link {url} to the library under brief {briefId}.
        slots:
          url: requestBody.url
          briefId: requestBody.briefId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/files/library/{id}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a library file
      effect: read
      questions:
      - How do I download a document stored in my library?
      - Are library files ever served publicly?
      instructions:
      - text: Download library item {id}.
        slots:
          id: path.id
      - text: Get the original file for library document {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/files/library/{id}/content'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the text content of a library document
      effect: read
      questions:
      - Can an agent read the text inside a library PDF page by page?
      - Can I pull a specific image out of a library document?
      instructions:
      - text: Read the content of library document {id}.
        slots:
          id: path.id
      - text: Read library document {id} from cursor {cursor}, {limit} pages.
        slots:
          id: path.id
          cursor: query.cursor
          limit: query.limit
      - text: Get image {imageRef} from library document {id}.
        slots:
          imageRef: query.imageRef
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/files/library/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a library item
      effect: destructive
      questions:
      - Does deleting a library item also remove the stored file?
      - Can I remove a link from my library?
      instructions:
      - text: Delete library item {id}.
        slots:
          id: path.id
      - text: Remove library document {id} and its stored bytes.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/files/library/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or reattach a library item
      effect: write
      questions:
      - Can I rename a document in my library?
      - How do I detach a library item from a lead but keep it in the library?
      instructions:
      - text: Rename library item {id} to {title}.
        slots:
          id: path.id
          title: requestBody.title
      - text: Attach library item {id} to brief {briefId}.
        slots:
          id: path.id
          briefId: requestBody.briefId
      method: generated
      generated: '2026-10-01'