# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Canva Connect Folder API
  version: 1.0.0
extends: openapi/canva-folder-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['/v1/folders/{folderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a folder's details
      effect: read
      questions:
      - How do I look up a folder's name by its ID?
      - What details does Canva keep about a folder?
      instructions:
      - text: Get folder {folderId}.
        slots:
          folderId: path.folderId
      - text: Show the name of folder {folderId}.
        slots:
          folderId: path.folderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/folders/{folderId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a folder
      effect: destructive
      questions:
      - What happens to the contents when I delete a folder?
      - Can I delete a folder through the API?
      instructions:
      - text: Delete folder {folderId}.
        slots:
          folderId: path.folderId
      - text: Remove folder {folderId} and send my items in it to the trash.
        slots:
          folderId: path.folderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/folders/{folderId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a folder
      effect: write
      questions:
      - How do I rename a folder?
      - Besides the name, can I change anything else on a folder?
      instructions:
      - text: Rename folder {folderId} to {name}.
        slots:
          folderId: path.folderId
          name: requestBody.name
      - text: Change the name of folder {folderId} to {name}.
        slots:
          folderId: path.folderId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/folders/{folderId}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List the contents of a folder
      effect: read
      questions:
      - What designs, images and subfolders are inside a folder?
      - Can I list only pinned items or only designs in a folder?
      - Do brand templates show up when listing folder contents?
      instructions:
      - text: List the items in folder {folderId}.
        slots:
          folderId: path.folderId
      - text: List only {item_types} items in folder {folderId}.
        slots:
          item_types: query.item_types
          folderId: path.folderId
      - text: Show pinned status {pin_status} items in folder {folderId} sorted by {sort_by}.
        slots:
          pin_status: query.pin_status
          folderId: path.folderId
          sort_by: query.sort_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/folders/move'].post
  update:
    x-apievangelist-phrasing:
      intent: Move an item to another folder
      effect: write
      questions:
      - How do I move a design into a different folder?
      - What happens if the item I move is in more than one folder?
      instructions:
      - text: Move item {item_id} to folder {to_folder_id}.
        slots:
          item_id: requestBody.item_id
          to_folder_id: requestBody.to_folder_id
      - text: Put item {item_id} into folder {to_folder_id}.
        slots:
          item_id: requestBody.item_id
          to_folder_id: requestBody.to_folder_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/folders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a folder
      effect: write
      questions:
      - How do I create a new folder in my Canva projects?
      - Can I create a folder inside my Uploads folder or another folder?
      instructions:
      - text: Create folder {name} inside {parent_folder_id}.
        slots:
          name: requestBody.name
          parent_folder_id: requestBody.parent_folder_id
      - text: Make a new top-level folder named {name} under {parent_folder_id}.
        slots:
          name: requestBody.name
          parent_folder_id: requestBody.parent_folder_id
      method: generated
      generated: '2026-09-26'