Google Dialogflow · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dialogflow CX API (v3) - Conversational Agents Pages API

6 actions 6 updates phrasing extends openapi/google-dialogflow-pages-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Google Dialogflow's API. It is a proposal applied on top of the contract, not a document Google Dialogflow publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages/{pagesId}'].get
$.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages/{pagesId}'].delete
$.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages/{pagesId}'].patch
$.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages'].get
$.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages'].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 Dialogflow CX API (v3) - Conversational Agents Pages API
  version: 1.0.0
extends: openapi/google-dialogflow-pages-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: 5
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages/{pagesId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a page in a CX flow
      effect: read
      questions:
      - What form, routes and entry fulfillment does a page in my Dialogflow CX flow have?
      - Can I fetch a CX page's content in a specific language?
      instructions:
      - text: Get page {page} in flow {flow} of CX agent {agent}, project {project}, location {location}.
        slots:
          page: path.pagesId
          flow: path.flowsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show page {page} of flow {flow} in language {language} on agent {agent} ({project}/{location}).
        slots:
          page: path.pagesId
          flow: path.flowsId
          language: query.languageCode
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages/{pagesId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a page from a CX flow
      effect: destructive
      questions:
      - Can I delete a page from a Dialogflow CX flow?
      - Can I force-delete a CX page that other routes still point to?
      instructions:
      - text: Delete page {page} from flow {flow} of CX agent {agent}, project {project}, location {location}.
        slots:
          page: path.pagesId
          flow: path.flowsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Force-remove page {page} with force={force} from flow {flow} on agent {agent} ({project}/{location}).
        slots:
          page: path.pagesId
          force: query.force
          flow: path.flowsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages/{pagesId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a page in a CX flow
      effect: write
      questions:
      - How do I change the form parameters or routes on an existing Dialogflow CX page?
      - Can I update a CX page's entry fulfillment message without touching the rest?
      instructions:
      - text: Rename page {page} in flow {flow} of CX agent {agent} ({project}/{location}) to {display_name}.
        slots:
          page: path.pagesId
          flow: path.flowsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          display_name: requestBody.displayName
      - text: Set the entry fulfillment of page {page} in flow {flow} to {fulfillment}, updating only {update_mask}, on agent {agent}, project {project}, location {location}.
        slots:
          page: path.pagesId
          flow: path.flowsId
          fulfillment: requestBody.entryFulfillment
          update_mask: query.updateMask
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages'].get
  update:
    x-apievangelist-phrasing:
      intent: List pages in a CX flow
      effect: read
      questions:
      - What pages make up a given flow in my Dialogflow CX agent?
      - Can I page through a CX flow's pages in one language?
      instructions:
      - text: List the pages in flow {flow} of CX agent {agent}, project {project}, location {location}.
        slots:
          flow: path.flowsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show {page_size} pages at a time from flow {flow} in language {language} on agent {agent} ({project}/{location}).
        slots:
          page_size: query.pageSize
          flow: path.flowsId
          language: query.languageCode
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a page in a CX flow
      effect: write
      questions:
      - How do I add a new page to a Dialogflow CX flow?
      - Can I give a new CX page a form to collect parameters from the user?
      instructions:
      - text: Create page {display_name} in flow {flow} of CX agent {agent}, project {project}, location {location}.
        slots:
          display_name: requestBody.displayName
          flow: path.flowsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Add a page {display_name} with form {form} to flow {flow} on agent {agent} ({project}/{location}).
        slots:
          display_name: requestBody.displayName
          form: requestBody.form
          flow: path.flowsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'