GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 File Library API

9 actions 9 updates phrasing extends openapi/getresponse-file-library-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for GetResponse's API. It is a proposal applied on top of the contract, not a document GetResponse publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/file-library/files/{fileId}'].get
$.paths['/file-library/files/{fileId}'].delete
$.paths['/file-library/folders/{folderId}'].delete
$.paths['/file-library/quota'].get
$.paths['/file-library/files'].get
$.paths['/file-library/files'].post
$.paths['/file-library/folders'].get
$.paths['/file-library/folders'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for GetResponse APIv3 File Library API
  version: 1.0.0
extends: openapi/getresponse-file-library-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: 8
- target: $.paths['/file-library/files/{fileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a file from the file library
      effect: read
      questions:
      - Can I get the details and URL of one file in my library?
      - What size and type is a specific uploaded file?
      instructions:
      - text: Get file {file} from my file library.
        slots:
          file: path.fileId
      - text: Show the {fields} of library file {file}.
        slots:
          fields: query.fields
          file: path.fileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/file-library/files/{fileId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a file from the library
      effect: destructive
      questions:
      - How do I remove an uploaded file I no longer need?
      - Is deleting a library file permanent?
      instructions:
      - text: Delete file {file} from the file library.
        slots:
          file: path.fileId
      - text: Remove library file {file}.
        slots:
          file: path.fileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/file-library/folders/{folderId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a file library folder
      effect: destructive
      questions:
      - Can I delete a whole folder from my file library?
      - What's the way to clean up an empty folder I created?
      instructions:
      - text: Delete folder {folder} from the file library.
        slots:
          folder: path.folderId
      - text: Remove library folder {folder}.
        slots:
          folder: path.folderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/file-library/quota'].get
  update:
    x-apievangelist-phrasing:
      intent: Check file library storage usage
      effect: read
      questions:
      - How much storage space do I have left in my file library?
      - Am I close to my file storage limit?
      instructions:
      - text: Show my file library storage quota.
      - text: Tell me how much library space is used and free.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/file-library/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List files in the file library
      effect: read
      questions:
      - Which files are in my library, including those in subfolders?
      - Can I list only the images or documents in one folder?
      instructions:
      - text: List files in folder {folder}.
        slots:
          folder: query.query[folderId]
      - text: Find library files named {name} across all folders.
        slots:
          name: query.query[name]
      - text: List my library files of type {group}.
        slots:
          group: query.query[group]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/file-library/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file to the library
      effect: write
      questions:
      - How do I upload a file to my GetResponse file library?
      - Can I put an uploaded file straight into a specific folder?
      instructions:
      - text: Upload file {name} with extension {extension} to the library.
        slots:
          name: requestBody.name
          extension: requestBody.extension
      - text: Upload {name} into library folder {folder}.
        slots:
          name: requestBody.name
          folder: requestBody.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/file-library/folders'].get
  update:
    x-apievangelist-phrasing:
      intent: List file library folders
      effect: read
      questions:
      - What folders exist in my file library?
      - Can I sort library folders by size?
      instructions:
      - text: List my file library folders.
      - text: Find library folders named {name}.
        slots:
          name: query.query[name]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/file-library/folders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a file library folder
      effect: write
      questions:
      - Can I organise my uploads into a new folder?
      - What's needed to make a folder in the file library?
      instructions:
      - text: Create a library folder called {name}.
        slots:
          name: requestBody.name
      - text: Make a new file library folder named {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'