2025-05-02
▼ ▲ integrations.projects.locations.collections.engines.assistants.agentFlows.delete
Path : v1/{+name}
Parameters :
name
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agentFlows/[^/]+$
Location : path
Description : Required. The resource name of the AgentFlow to delete.
Description : Deletes an existing AgentFlow.
HTTP Method : DELETE
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agentFlows/{agentFlowsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ integrations.projects.locations.collections.engines.assistants.agentFlows.list
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agentFlows
Path : v1/{+parent}/agentFlows
Description : Lists all AgentFlows.
Parameter Order : parent
Parameters :
readMask
Format : google-fieldmask
Location : query
Description : Optional. The mask which specifies fields that need to be returned in the AgentFlow's response.
Type : string
pageToken
Type : string
Location : query
Description : Optional. A page token, received from a previous `ListAgentFlows` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAgentFlows` must match the call that provided the page token.
parent
Description : Required. The parent resource where this AgentFlow was created.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$
Required : Yes
Type : string
orderBy
Description : Optional. The results would be returned in order specified here. Currently supported sort keys are: Descending sort order for "create_time", "update_time". Ascending sort order for "agent_flow_id", "display_name".
Location : query
Type : string
filter
Location : query
Type : string
Description : Optional. Standard filter field. Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
pageSize
Description : Optional. The maximum number of AgentFlows to return. The service may return fewer than this value. If unspecified, at most 100 AgentFlows will be returned.
Location : query
Type : integer
Format : int32
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
▼ ▲ integrations.projects.locations.collections.engines.assistants.agentFlows.generate
Path : v1/{+parent}/agentFlows:generate
Parameters :
parent
Type : string
Location : path
Description : Required. Parent resource name where this AgentFlow will be created.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$
Parameter Order : parent
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Uses Natural Language (NL) to generate an AgentFlow configuration and create a new AgentFlow.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agentFlows:generate
▼ ▲ integrations.projects.locations.collections.engines.assistants.agentFlows.create
Description : Request to create a new AgentFlow with user-provided flow configuration.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agentFlows
Parameters :
parent
Type : string
Location : path
Description : Required. Parent resource name where this AgentFlow will be created.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$
Parameter Order : parent
HTTP Method : POST
Path : v1/{+parent}/agentFlows
▼ ▲ integrations.projects.locations.collections.engines.assistants.agentFlows.patch
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agentFlows/{agentFlowsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Description : Updates an existing AgentFlow.
HTTP Method : PATCH
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agentFlows/[^/]+$
Location : path
Description : Required. Resource name of the agent flow.
Type : string
Required : Yes
updateMask
Description : Optional. Field mask specifying the fields in the above AgentFlow that have been modified and need to be updated.
Location : query
Type : string
Format : google-fieldmask
Path : v1/{+name}
▼ ▲ integrations.projects.locations.collections.engines.assistants.agentFlows.generateAndUpdate
Parameter Order : name
HTTP Method : POST
Path : v1/{+name}:generateAndUpdate
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agentFlows/[^/]+$
Description : Required. The resource name of the AgentFlow to update.
Type : string
Required : Yes
Location : path
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agentFlows/{agentFlowsId}:generateAndUpdate
Description : Uses Natural Language (NL) to generate an AgentFlow configuration and update an existing AgentFlow.
▼ ▲ integrations.projects.locations.collections.engines.assistants.agentFlows.get
Path : v1/{+name}
Description : Gets an existing AgentFlow.
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agentFlows/{agentFlowsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agentFlows/[^/]+$
Description : Required. The resource name of the AgentFlow to get.
Required : Yes
Type : string
Location : path
Parameter Order : name