Some products and features are in the process of being renamed. Generative playbook and flow features are also being migrated to a single consolidated console. See the details .

Manage pages with the API

In most cases, you will use the console to manage pages. In advanced scenarios, you may wish to use the API to manage pages. This guide describes how to create, list, and delete pages using the API.

Create page

To create a page for your agent, call the create method on the Page type.

Select a protocol and version for the Page reference:

Protocol	V3	V3beta1
REST	Page resource	Page resource
RPC	Page interface	Page interface
C++	PagesClient	Not available
C#	PagesClient	Not available
Go	PagesClient	Not available
Java	PagesClient	PagesClient
Node.js	PagesClient	PagesClient
PHP	Not available	Not available
Python	PagesClient	PagesClient
Ruby	Not available	Not available

Java

To authenticate to Dialogflow, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  import 
  
 com.google.cloud.dialogflow.cx.v3. CreatePageRequest 
 
 ; 
 import 
  
 com.google.cloud.dialogflow.cx.v3. Page 
 
 ; 
 import 
  
 com.google.cloud.dialogflow.cx.v3. PagesClient 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 public 
  
 class 
 CreateSimplePage 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 String 
  
 projectId 
  
 = 
  
 "my-project-id" 
 ; 
  
 String 
  
 agentId 
  
 = 
  
 "my-agent-id" 
 ; 
  
 String 
  
 flowId 
  
 = 
  
 "my-flow-id" 
 ; 
  
 String 
  
 location 
  
 = 
  
 "my-location" 
 ; 
  
 String 
  
 displayName 
  
 = 
  
 "my-display-name" 
 ; 
  
 createPage 
 ( 
 projectId 
 , 
  
 agentId 
 , 
  
 flowId 
 , 
  
 location 
 , 
  
 displayName 
 ); 
  
 } 
  
 // DialogFlow API Create Page Sample. 
  
 // Creates a page from the provided parameters 
  
 public 
  
 static 
  
  Page 
 
  
 createPage 
 ( 
  
 String 
  
 projectId 
 , 
  
 String 
  
 agentId 
 , 
  
 String 
  
 flowId 
 , 
  
 String 
  
 location 
 , 
  
 String 
  
 displayName 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
  Page 
 
  
 response 
 ; 
  
  CreatePageRequest 
 
 . 
 Builder 
  
 createRequestBuilder 
  
 = 
  
  CreatePageRequest 
 
 . 
 newBuilder 
 (); 
  
  Page 
 
 . 
 Builder 
  
 pageBuilder 
  
 = 
  
  Page 
 
 . 
 newBuilder 
 (); 
  
 pageBuilder 
 . 
 setDisplayName 
 ( 
 displayName 
 ); 
  
 createRequestBuilder 
  
 . 
 setParent 
 ( 
  
 "projects/" 
  
 + 
  
 projectId 
  
 + 
  
 "/locations/" 
  
 + 
  
 location 
  
 + 
  
 "/agents/" 
  
 + 
  
 agentId 
  
 + 
  
 "/flows/" 
  
 + 
  
 flowId 
 ) 
  
 . 
 setPage 
 ( 
 pageBuilder 
 ); 
  
 // Make API request to create page 
  
 // Note: close() needs to be called on the PagesClient object to clean up resources 
  
 // such as threads. In the example below, try-with-resources is used, 
  
 // which automatically calls close(). 
  
 try 
  
 ( 
  PagesClient 
 
  
 client 
  
 = 
  
  PagesClient 
 
 . 
 create 
 ()) 
  
 { 
  
 response 
  
 = 
  
 client 
 . 
 createPage 
 ( 
 createRequestBuilder 
 . 
 build 
 ()); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Successfully created page!" 
 ); 
  
 return 
  
 response 
 ; 
  
 } 
  
 }

Node.js

To authenticate to Dialogflow, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  async 
  
 function 
  
 createPage 
 ( 
 projectId 
 , 
  
 agentId 
 , 
  
 flowId 
 , 
  
 location 
 , 
  
 displayName 
 ) 
  
 { 
  
 const 
  
 pagesClient 
  
 = 
  
 new 
  
 PagesClient 
 (); 
  
 const 
  
 createPageRequest 
  
 = 
  
 { 
  
 parent 
 : 
  
 `projects/ 
 ${ 
 projectId 
 } 
 /locations/ 
 ${ 
 location 
 } 
 /agents/ 
 ${ 
 agentId 
 } 
 /flows/ 
 ${ 
 flowId 
 } 
 ` 
 , 
  
 page 
 : 
  
 { 
  
 displayName 
 : 
  
 displayName 
 , 
  
 }, 
  
 }; 
  
 const 
  
 response 
  
 = 
  
 await 
  
 pagesClient 
 . 
 createPage 
 ( 
 createPageRequest 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
 }

Python

To authenticate to Dialogflow, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  async 
 def 
  
 create_page 
 ( 
 project_id 
 , 
 agent_id 
 , 
 flow_id 
 , 
 location 
 , 
 displayName 
 ): 
 pages_client 
 = 
 PagesAsyncClient 
 () 
 page 
 = 
 Page 
 () 
 page 
 . 
 display_name 
 = 
 displayName 
 request 
 = 
 CreatePageRequest 
 () 
 request 
 . 
 parent 
 = 
 ( 
 "projects/" 
 + 
 project_id 
 + 
 "/locations/" 
 + 
 location 
 + 
 "/agents/" 
 + 
 agent_id 
 + 
 "/flows/" 
 + 
 flow_id 
 ) 
 request 
 . 
 page 
 = 
 page 
 response 
 = 
 await 
 pages_client 
 . 
 create_page 
 ( 
 request 
 = 
 request 
 ) 
 return 
 response

List pages

To list the pages for your agent, call the list method on the Page type.

Select a protocol and version for the Page reference:

Protocol	V3	V3beta1
REST	Page resource	Page resource
RPC	Page interface	Page interface
C++	PagesClient	Not available
C#	PagesClient	Not available
Go	PagesClient	Not available
Java	PagesClient	PagesClient
Node.js	PagesClient	PagesClient
PHP	Not available	Not available
Python	PagesClient	PagesClient
Ruby	Not available	Not available

Java

To authenticate to Dialogflow, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  import 
  
 com.google.cloud.dialogflow.cx.v3. ListPagesRequest 
 
 ; 
 import 
  
 com.google.cloud.dialogflow.cx.v3. ListPagesRequest 
.Builder 
 ; 
 import 
  
 com.google.cloud.dialogflow.cx.v3. Page 
 
 ; 
 import 
  
 com.google.cloud.dialogflow.cx.v3. PagesClient 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 public 
  
 class 
 ListPages 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 String 
  
 projectId 
  
 = 
  
 "my-project-id" 
 ; 
  
 String 
  
 agentId 
  
 = 
  
 "my-agent-id" 
 ; 
  
 String 
  
 flowId 
  
 = 
  
 "my-flow-id" 
 ; 
  
 String 
  
 location 
  
 = 
  
 "my-location" 
 ; 
  
 listPages 
 ( 
 projectId 
 , 
  
 agentId 
 , 
  
 flowId 
 , 
  
 location 
 ); 
  
 } 
  
 // DialogFlow API List Pages Sample. 
  
 // Lists all pages from the provided parameters 
  
 public 
  
 static 
  
 void 
  
 listPages 
 ( 
 String 
  
 projectId 
 , 
  
 String 
  
 agentId 
 , 
  
 String 
  
 flowId 
 , 
  
 String 
  
 location 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 // Note: close() needs to be called on the PagesClient object to clean up resources 
  
 // such as threads. In the example below, try-with-resources is used, 
  
 // which automatically calls close(). 
  
 try 
  
 ( 
  PagesClient 
 
  
 client 
  
 = 
  
  PagesClient 
 
 . 
 create 
 ()) 
  
 { 
  
 Builder 
  
 listRequestBuilder 
  
 = 
  
  ListPagesRequest 
 
 . 
 newBuilder 
 (); 
  
 String 
  
 parentPath 
  
 = 
  
 String 
 . 
 format 
 ( 
  
 "projects/%s/locations/%s/agents/%s/flows/%s" 
 , 
  
 projectId 
 , 
  
 location 
 , 
  
 agentId 
 , 
  
 flowId 
 ); 
  
 listRequestBuilder 
 . 
 setParent 
 ( 
 parentPath 
 ); 
  
 listRequestBuilder 
 . 
 setLanguageCode 
 ( 
 "en" 
 ); 
  
 // Make API request to list all pages in the project 
  
 for 
  
 ( 
  Page 
 
  
 element 
  
 : 
  
 client 
 . 
 listPages 
 ( 
 listRequestBuilder 
 . 
 build 
 ()). 
 iterateAll 
 ()) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 element 
 ); 
  
 } 
  
 } 
  
 }

Node.js

To authenticate to Dialogflow, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  async 
  
 function 
  
 listPages 
 ( 
 projectId 
 , 
  
 agentId 
 , 
  
 flowId 
 , 
  
 location 
 ) 
  
 { 
  
 const 
  
 pagesClient 
  
 = 
  
 new 
  
 PagesClient 
 (); 
  
 const 
  
 listPageRequest 
  
 = 
  
 { 
  
 parent 
 : 
  
 `projects/ 
 ${ 
 projectId 
 } 
 /locations/ 
 ${ 
 location 
 } 
 /agents/ 
 ${ 
 agentId 
 } 
 /flows/ 
 ${ 
 flowId 
 } 
 ` 
 , 
  
 languageCode 
 : 
  
 'en' 
 , 
  
 }; 
  
 const 
  
 response 
  
 = 
  
 await 
  
 pagesClient 
 . 
 listPages 
 ( 
 listPageRequest 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
 }

Python

To authenticate to Dialogflow, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  async 
 def 
  
 list_page 
 ( 
 project_id 
 , 
 agent_id 
 , 
 flow_id 
 , 
 location 
 ): 
 pages_client 
 = 
 PagesAsyncClient 
 () 
 request 
 = 
 ListPagesRequest 
 () 
 request 
 . 
 parent 
 = 
 ( 
 f 
 "projects/ 
 { 
 project_id 
 } 
 /locations/ 
 { 
 location 
 } 
 /agents/ 
 { 
 agent_id 
 } 
 /flows/ 
 { 
 flow_id 
 } 
 " 
 ) 
 request 
 . 
 language_code 
 = 
 "en" 
 response 
 = 
 await 
 pages_client 
 . 
 list_pages 
 ( 
 request 
 = 
 request 
 ) 
 return 
 response

Delete pages

To delete a page for your agent, call the delete method on the Page type.

Select a protocol and version for the Page reference:

Protocol	V3	V3beta1
REST	Page resource	Page resource
RPC	Page interface	Page interface
C++	PagesClient	Not available
C#	PagesClient	Not available
Go	PagesClient	Not available
Java	PagesClient	PagesClient
Node.js	PagesClient	PagesClient
PHP	Not available	Not available
Python	PagesClient	PagesClient
Ruby	Not available	Not available

Java

To authenticate to Dialogflow, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  import 
  
 com.google.cloud.dialogflow.cx.v3. DeletePageRequest 
 
 ; 
 import 
  
 com.google.cloud.dialogflow.cx.v3. DeletePageRequest 
.Builder 
 ; 
 import 
  
 com.google.cloud.dialogflow.cx.v3. PagesClient 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 public 
  
 class 
 DeletePage 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 String 
  
 projectId 
  
 = 
  
 "my-project-id" 
 ; 
  
 String 
  
 agentId 
  
 = 
  
 "my-agent-id" 
 ; 
  
 String 
  
 flowId 
  
 = 
  
 "my-flow-id" 
 ; 
  
 String 
  
 pageId 
  
 = 
  
 "my-page-id" 
 ; 
  
 String 
  
 location 
  
 = 
  
 "my-location" 
 ; 
  
 deletePage 
 ( 
 projectId 
 , 
  
 agentId 
 , 
  
 flowId 
 , 
  
 pageId 
 , 
  
 location 
 ); 
  
 } 
  
 // DialogFlow API Delete Page Sample. 
  
 // Deletes a page from the provided parameters 
  
 public 
  
 static 
  
 void 
  
 deletePage 
 ( 
  
 String 
  
 projectId 
 , 
  
 String 
  
 agentId 
 , 
  
 String 
  
 flowId 
 , 
  
 String 
  
 pageId 
 , 
  
 String 
  
 location 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 // Note: close() needs to be called on the PagesClient object to clean up resources 
  
 // such as threads. In the example below, try-with-resources is used, 
  
 // which automatically calls close(). 
  
 try 
  
 ( 
  PagesClient 
 
  
 client 
  
 = 
  
  PagesClient 
 
 . 
 create 
 ()) 
  
 { 
  
 Builder 
  
 deleteRequestBuilder 
  
 = 
  
  DeletePageRequest 
 
 . 
 newBuilder 
 (); 
  
 deleteRequestBuilder 
 . 
 setName 
 ( 
  
 "projects/" 
  
 + 
  
 projectId 
  
 + 
  
 "/locations/" 
  
 + 
  
 location 
  
 + 
  
 "/agents/" 
  
 + 
  
 agentId 
  
 + 
  
 "/flows/" 
  
 + 
  
 flowId 
  
 + 
  
 "/pages/" 
  
 + 
  
 pageId 
 ); 
  
 // Make API request to delete page 
  
 client 
 . 
 deletePage 
 ( 
 deleteRequestBuilder 
 . 
 build 
 ()); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Successfully deleted page!" 
 ); 
  
 } 
  
 }

Node.js

To authenticate to Dialogflow, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  async 
  
 function 
  
 deletePage 
 ( 
 projectId 
 , 
  
 agentId 
 , 
  
 flowId 
 , 
  
 pageId 
 , 
  
 location 
 ) 
  
 { 
  
 const 
  
 pagesClient 
  
 = 
  
 new 
  
 PagesClient 
 (); 
  
 const 
  
 req 
  
 = 
  
 { 
  
 name 
 : 
  
 `projects/ 
 ${ 
 projectId 
 } 
 /locations/ 
 ${ 
 location 
 } 
 /agents/ 
 ${ 
 agentId 
 } 
 /flows/ 
 ${ 
 flowId 
 } 
 /pages/ 
 ${ 
 pageId 
 } 
 ` 
 , 
  
 }; 
  
 const 
  
 response 
  
 = 
  
 await 
  
 pagesClient 
 . 
 deletePage 
 ( 
 req 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
 }

Python

To authenticate to Dialogflow, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  async 
 def 
  
 delete_page 
 ( 
 project_id 
 , 
 agent_id 
 , 
 flow_id 
 , 
 page_id 
 , 
 location 
 ): 
 pages_client 
 = 
 PagesAsyncClient 
 () 
 request 
 = 
 DeletePageRequest 
 () 
 request 
 . 
 name 
 = 
 f 
 "projects/ 
 { 
 project_id 
 } 
 /locations/ 
 { 
 location 
 } 
 /agents/ 
 { 
 agent_id 
 } 
 /flows/ 
 { 
 flow_id 
 } 
 /pages/ 
 { 
 page_id 
 } 
 " 
 response 
 = 
 await 
 pages_client 
 . 
 delete_page 
 ( 
 request 
 = 
 request 
 ) 
 return 
 response

Manage agents with the API

Manage intents with the API

Manage pages with the API Stay organized with collections Save and categorize content based on your preferences.

Create page

Java

Node.js

Python

List pages

Java

Node.js

Python

Delete pages

Java

Node.js

Python

Manage pages with the API