API Evangelist conversational phrasing for Postman Collections API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Postman Collections API
  version: 1.0.0
extends: openapi/postman-collections-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: 34
- target: $.paths['/collection-merges'].put
  update:
    x-apievangelist-phrasing:
      intent: Merge or pull fork changes asynchronously
      effect: write
      questions:
      - How do I merge a forked Postman collection into its parent in the background and track it as a task?
      - Can I pull the parent's changes into my fork with the async merge endpoint by swapping source and destination?
      instructions:
      - text: Start an async merge of fork {source} into parent collection {destination} using the {strategy} strategy.
        slots:
          source: requestBody.source
          destination: requestBody.destination
          strategy: requestBody.strategy
      - text: Queue an async pull of parent {source} into my fork {destination} with merge strategy {strategy}.
        slots:
          source: requestBody.source
          destination: requestBody.destination
          strategy: requestBody.strategy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collection-merges-tasks/{taskId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a collection merge or pull task
      effect: read
      questions:
      - Did my async collection merge or pull task finish, or is it still running?
      - How long is the status of a finished collection merge task kept around?
      instructions:
      - text: Check the status of collection merge task {taskId}.
        slots:
          taskId: path.taskId
      - text: Tell me whether the pull-changes task {taskId} succeeded or failed.
        slots:
          taskId: path.taskId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections'].get
  update:
    x-apievangelist-phrasing:
      intent: List my collections
      effect: read
      questions:
      - What collections do I have access to, including ones I'm subscribed to?
      - Can I list only the collections in one workspace, or find a collection by name?
      - How do I page through a long list of my collections?
      instructions:
      - text: List all my Postman collections.
      - text: List the collections in workspace {workspace}.
        slots:
          workspace: query.workspace
      - text: Find collections named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a collection
      effect: write
      questions:
      - How do I create a new collection in a specific workspace through the API?
      - Which collection format does the create-collection endpoint expect?
      instructions:
      - text: Create a new collection in workspace {workspace}.
        slots:
          workspace: query.workspace
      - text: Create collection {collection} in workspace {workspace} using the v2.1.0 format.
        slots:
          collection: requestBody.collection
          workspace: query.workspace
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/collection-forks'].get
  update:
    x-apievangelist-phrasing:
      intent: List the collections I have forked
      effect: read
      questions:
      - Which collections have I forked?
      - Can I see my own collection forks sorted newest first?
      instructions:
      - text: List all the collections I've forked.
      - text: Show my forked collections, {limit} at a time.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/fork/{collectionId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Fork a collection into a workspace
      effect: write
      questions:
      - How do I fork an existing collection into another workspace?
      - Do I have to give a label when I fork a collection?
      instructions:
      - text: Fork collection {collectionId} into workspace {workspace} with the label {label}.
        slots:
          collectionId: path.collectionId
          workspace: query.workspace
          label: requestBody.label
      - text: Make a fork of collection {collectionId} in workspace {workspace}.
        slots:
          collectionId: path.collectionId
          workspace: query.workspace
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/merge'].post
  update:
    x-apievangelist-phrasing:
      intent: Merge a fork using the deprecated endpoint
      effect: write
      questions:
      - Is there an older synchronous endpoint for merging a forked collection back into its parent?
      - What role do I need to merge a fork with the deprecated merge endpoint?
      instructions:
      - text: Use the deprecated merge endpoint to merge fork {source} into parent collection {destination}.
        slots:
          source: requestBody.source
          destination: requestBody.destination
      - text: Merge fork {source} into {destination} the legacy way with strategy {strategy}.
        slots:
          source: requestBody.source
          destination: requestBody.destination
          strategy: requestBody.strategy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a collection
      effect: read
      questions:
      - How do I fetch the full contents of one collection by its ID?
      - Can I read a collection with just a read-only access key instead of an API key?
      - Is there a way to get only a collection's root-level folder and request IDs?
      instructions:
      - text: Get collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Fetch collection {collectionId} using the access key {access_key}.
        slots:
          collectionId: path.collectionId
          access_key: query.access_key
      - text: Show only the root-level requests and folders of collection {collectionId}.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a collection's contents
      effect: write
      questions:
      - How do I overwrite an entire collection with new contents?
      - What happens to existing items if I replace a collection without including their IDs?
      - Can a full collection replacement run asynchronously?
      instructions:
      - text: Replace everything in collection {collectionId} with {collection}.
        slots:
          collectionId: path.collectionId
          collection: requestBody.collection
      - text: Overwrite collection {collectionId} asynchronously and give me the task to track.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a collection
      effect: destructive
      questions:
      - How do I permanently delete a collection?
      - Can I remove a collection I no longer need through the API?
      instructions:
      - text: Delete collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Remove the collection {collectionId} from Postman.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a collection's name, events or variables
      effect: write
      questions:
      - Can I rename a collection without replacing all of its requests?
      - How do I change just a collection's variables or scripts?
      instructions:
      - text: Rename collection {collectionId} and keep its items as they are.
        slots:
          collectionId: path.collectionId
      - text: Partially update collection {collectionId} with {collection}.
        slots:
          collectionId: path.collectionId
          collection: requestBody.collection
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}/comments'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a collection
      effect: read
      questions:
      - What comments have people left on this collection?
      - Can I read the whole comment history of a collection?
      instructions:
      - text: List the comments on collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Show me who commented on collection {collectionId} and what they said.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}/comments'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a collection
      effect: write
      questions:
      - How do I leave a comment on a collection?
      - Can I reply to an existing collection comment thread, and how long can a comment be?
      instructions:
      - text: Comment {body} on collection {collectionId}.
        slots:
          body: requestBody.body
          collectionId: path.collectionId
      - text: Reply {body} in thread {threadId} on collection {collectionId}.
        slots:
          body: requestBody.body
          threadId: requestBody.threadId
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}/comments/{commentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a comment on a collection
      effect: write
      questions:
      - Can I edit a comment I already posted on a collection?
      - Is there a character limit when editing a collection comment?
      instructions:
      - text: Change comment {commentId} on collection {collectionId} to {body}.
        slots:
          commentId: path.commentId
          collectionId: path.collectionId
          body: requestBody.body
      - text: Edit my collection comment {commentId} in {collectionId} to say {body}.
        slots:
          commentId: path.commentId
          collectionId: path.collectionId
          body: requestBody.body
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}/comments/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a collection
      effect: destructive
      questions:
      - What happens to the replies if I delete the first comment in a collection thread?
      - How do I remove a comment from a collection?
      instructions:
      - text: Delete comment {commentId} from collection {collectionId}.
        slots:
          commentId: path.commentId
          collectionId: path.collectionId
      - text: Remove collection comment {commentId} on {collectionId} and its thread if it's the first one.
        slots:
          commentId: path.commentId
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}/duplicates'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate a collection into another workspace
      effect: write
      questions:
      - How do I copy a collection into a different workspace?
      - Can I add a suffix to the name of a duplicated collection?
      instructions:
      - text: Duplicate collection {collectionId} into workspace {workspace}.
        slots:
          collectionId: path.collectionId
          workspace: requestBody.workspace
      - text: Copy collection {collectionId} to workspace {workspace} with the name suffix {suffix}.
        slots:
          collectionId: path.collectionId
          workspace: requestBody.workspace
          suffix: requestBody.suffix
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}/forks'].get
  update:
    x-apievangelist-phrasing:
      intent: List a collection's forks
      effect: read
      questions:
      - Who has forked this collection and when?
      - Can I list every fork made from one of my collections?
      instructions:
      - text: List the forks of collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Show who forked collection {collectionId}, newest forks first.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}/public-documentations'].put
  update:
    x-apievangelist-phrasing:
      intent: Publish a collection's documentation
      effect: write
      questions:
      - How do I make a collection's documentation public to anyone with the link?
      - Can I choose the colors and layout when publishing collection docs?
      - Which environment's variables get published with the documentation?
      instructions:
      - text: Publish the documentation for collection {collectionId} with theme colors {customColor}.
        slots:
          collectionId: path.collectionId
          customColor: requestBody.customColor
      - text: Publish docs for collection {collectionId} in the {documentationLayout} layout.
        slots:
          collectionId: path.collectionId
          documentationLayout: requestBody.documentationLayout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}/public-documentations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unpublish a collection's documentation
      effect: destructive
      questions:
      - How do I take a collection's public documentation offline?
      - Can I make published collection docs private again?
      instructions:
      - text: Unpublish the documentation for collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Take down the public docs for collection {collectionId}.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}/pulls'].put
  update:
    x-apievangelist-phrasing:
      intent: Pull parent changes into a forked collection
      effect: write
      questions:
      - My fork is behind its parent collection; how do I bring in the latest changes?
      - Is there a synchronous way to pull source changes into a forked collection?
      instructions:
      - text: Pull the parent collection's changes into my fork {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Sync forked collection {collectionId} with its source now.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}/pull-requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List a collection's pull requests
      effect: read
      questions:
      - What pull requests are open against this collection?
      - Can I see the status and link of each pull request on a collection?
      instructions:
      - text: List the pull requests for collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Show the pull request statuses on collection {collectionId}.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}/pull-requests'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a pull request from a forked collection
      effect: write
      questions:
      - How do I open a pull request from my forked collection into the parent?
      - Can I assign reviewers when creating a collection pull request?
      instructions:
      - text: Open a pull request titled {title} from fork {collectionId} into {destinationId} with reviewers {reviewers}.
        slots:
          title: requestBody.title
          collectionId: path.collectionId
          destinationId: requestBody.destinationId
          reviewers: requestBody.reviewers
      - text: Create a pull request from {collectionId} to parent {destinationId}, titled {title}, reviewed by {reviewers}.
        slots:
          collectionId: path.collectionId
          destinationId: requestBody.destinationId
          title: requestBody.title
          reviewers: requestBody.reviewers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: See who can view or edit a collection
      effect: read
      questions:
      - Which users, teams and groups have access to this collection?
      - Who has editor access on a given collection?
      instructions:
      - text: List the roles on collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Show who can view or edit collection {collectionId}.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}/roles'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change who can access a collection
      effect: write
      questions:
      - How do I give a user editor access to a collection?
      - Can I change the roles of groups or teams on a collection, and who is allowed to?
      instructions:
      - text: Update the roles on collection {collectionId} to {roles}.
        slots:
          collectionId: path.collectionId
          roles: requestBody.roles
      - text: Grant or revoke collection access on {collectionId} with {roles}.
        slots:
          collectionId: path.collectionId
          roles: requestBody.roles
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}/source-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a fork is behind its parent
      effect: read
      questions:
      - Has the parent collection changed since I forked it?
      - How can I tell if my forked collection is out of date with its source?
      instructions:
      - text: Check whether the source of forked collection {collectionId} is ahead.
        slots:
          collectionId: path.collectionId
      - text: Tell me if fork {collectionId} is missing changes from its parent.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}/transformations'].get
  update:
    x-apievangelist-phrasing:
      intent: Convert a collection to OpenAPI
      effect: read
      questions:
      - Can I generate an OpenAPI definition from an existing collection?
      - Does converting a collection to OpenAPI create an API, and can I get JSON or YAML?
      instructions:
      - text: Convert collection {collectionId} to an OpenAPI definition.
        slots:
          collectionId: path.collectionId
      - text: Export collection {collectionId} as OpenAPI in {format} format.
        slots:
          collectionId: path.collectionId
          format: query.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collection-folders-transfers'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy or move folders between collections
      effect: write
      questions:
      - How do I move folders from one collection into another?
      - Can I copy folders into another folder instead of moving them?
      instructions:
      - text: '{mode} folders {ids} into {target} at position {location}.'
        slots:
          mode: requestBody.mode
          ids: requestBody.ids
          target: requestBody.target
          location: requestBody.location
      - text: Move folders {ids} into collection or folder {target}, placed {location}; mode {mode}.
        slots:
          ids: requestBody.ids
          target: requestBody.target
          location: requestBody.location
          mode: requestBody.mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collection-requests-transfers'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy or move requests between collections
      effect: write
      questions:
      - Can I copy saved requests from one collection into another collection or folder?
      - What's the way to move several requests at once into a different folder?
      instructions:
      - text: Transfer requests {ids} to {target} at {location} using mode {mode}.
        slots:
          ids: requestBody.ids
          target: requestBody.target
          location: requestBody.location
          mode: requestBody.mode
      - text: Copy requests {ids} into folder {target}, positioned {location}, with mode {mode}.
        slots:
          ids: requestBody.ids
          target: requestBody.target
          location: requestBody.location
          mode: requestBody.mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collection-responses-transfers'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy or move saved responses to a request
      effect: write
      questions:
      - Can I move saved example responses from one request to another?
      - How do I copy example responses onto a different request?
      instructions:
      - text: Transfer responses {ids} to request {target} at {location} with mode {mode}.
        slots:
          ids: requestBody.ids
          target: requestBody.target
          location: requestBody.location
          mode: requestBody.mode
      - text: Move example responses {ids} onto request {target}, placed {location}; mode {mode}.
        slots:
          ids: requestBody.ids
          target: requestBody.target
          location: requestBody.location
          mode: requestBody.mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collection-duplicate-tasks/{taskId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a collection duplication task
      effect: read
      questions:
      - Has my collection duplication finished yet?
      - What's the status of copying a collection into another workspace?
      instructions:
      - text: Check the status of duplication task {taskId}.
        slots:
          taskId: path.taskId
      - text: Tell me if collection copy task {taskId} is done.
        slots:
          taskId: path.taskId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collection-updates-tasks/{taskId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an async collection update task
      effect: read
      questions:
      - Did my asynchronous collection replacement complete?
      - What is the status of a background collection update?
      instructions:
      - text: Check the status of async collection update task {taskId}.
        slots:
          taskId: path.taskId
      - text: Tell me whether collection update task {taskId} succeeded.
        slots:
          taskId: path.taskId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}/requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List all requests in a collection
      effect: read
      questions:
      - What requests does this collection contain, with their methods and URLs?
      - Can I see every request in a collection along with its folder?
      instructions:
      - text: List every request in collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Show the methods and URLs of all requests in collection {collectionId}.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}/folders'].get
  update:
    x-apievangelist-phrasing:
      intent: List all folders in a collection
      effect: read
      questions:
      - What's the folder structure inside this collection?
      - Can I list all folders of a collection with their hierarchy?
      instructions:
      - text: List all folders in collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Show the folder hierarchy of collection {collectionId}.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collections/{collectionId}/responses'].get
  update:
    x-apievangelist-phrasing:
      intent: List all saved responses in a collection
      effect: read
      questions:
      - Which saved example responses exist across a collection?
      - Can I pull every example response with its status code and body from one collection?
      instructions:
      - text: List all saved example responses in collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Show status codes and bodies of every example response in collection {collectionId}.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'