2025-10-31
▼ ▲ discoveryengine.billingAccounts.billingAccountLicenseConfigs.list
Path : v1alpha/{+parent}/billingAccountLicenseConfigs
Scopes :
Parameter Order : parent
Flat Path : v1alpha/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs
Parameters :
pageSize
Location : query
Description : Optional. Not supported.
Type : integer
Format : int32
pageToken
Description : Optional. Not supported.
Type : string
Location : query
parent
Pattern : ^billingAccounts/[^/]+$
Location : path
Type : string
Required : Yes
Description : Required. Format: `billingAccounts/{billing_account}`.
Description : Lists all BillingAccountLicenseConfigs for a given billing account.
HTTP Method : GET
▼ ▲ discoveryengine.billingAccounts.billingAccountLicenseConfigs.get
Description : Gets a BillingAccountLicenseConfig.
Parameter Order : name
Scopes :
HTTP Method : GET
Path : v1alpha/{+name}
Parameters :
name
Location : path
Pattern : ^billingAccounts/[^/]+/billingAccountLicenseConfigs/[^/]+$
Description : Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.
Required : Yes
Type : string
Flat Path : v1alpha/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}
▼ ▲ discoveryengine.media.upload
HTTP Method : POST
Parameter Order : name
Mediaupload :
Accept : */*
Protocols :
Simple :
Multipart : Yes
Path : /upload/v1alpha/{+name}:uploadFile
Path : v1alpha/{+name}:uploadFile
Supportsmediaupload : Yes
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$
Required : Yes
Location : path
Description : Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
Scopes :
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}:uploadFile
Description : Uploads a file for the assistant to use as a source of information within the session.
▼ ▲ discoveryengine.projects.locations.dataStores.widgetConfigs.patch
Parameters :
name
Location : path
Type : string
Description : Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$
updateMask
Type : string
Description : Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
Location : query
Format : google-fieldmask
Description : Update a WidgetConfig.
Scopes :
HTTP Method : PATCH
Path : v1alpha/{+name}
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}
▼ ▲ discoveryengine.projects.locations.collections.engines.widgetConfigs.patch
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/widgetConfigs/[^/]+$
Description : Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
Type : string
Required : Yes
updateMask
Description : Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
Location : query
Format : google-fieldmask
Type : string
Parameter Order : name
Description : Update a WidgetConfig.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/widgetConfigs/{widgetConfigsId}
HTTP Method : PATCH
Path : v1alpha/{+name}
Scopes :
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.files.import
Scopes :
Description : Imports a file to an Agent. Currently only No-Code agents are supported.
Path : v1alpha/{+parent}/files:import
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/files:import
HTTP Method : POST
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Required : Yes
Location : path
Description : Required. The resource name of the Agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
Type : string
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.create
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents
HTTP Method : POST
Parameter Order : parent
Parameters :
parent
Type : string
Location : path
Description : Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$
Path : v1alpha/{+parent}/agents
Scopes :
Description : Creates an Agent.
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.get
Scopes :
Parameters :
name
Description : Required. Resource name of Agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Type : string
Location : path
Required : Yes
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}
Description : Gets an Agent.
HTTP Method : GET
Parameter Order : name
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.list
Scopes :
Description : Lists all Agents under an Assistant which were created by the caller.
Parameter Order : parent
HTTP Method : GET
Parameters :
pageSize
Type : integer
Format : int32
Location : query
Description : Optional. Maximum number of Agents to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
orderBy
Type : string
Description : Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `is_pinned` Example: * "update_time desc" * "is_pinned desc,update_time desc": list agents by is_pinned first, then by update_time.
Location : query
pageToken
Description : Optional. A page token ListAgentsResponse.next_page_token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAgents must match the call that provided the page token.
Location : query
Type : string
parent
Description : Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$
Type : string
Location : path
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents
Path : v1alpha/{+parent}/agents
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.delete
Parameter Order : name
Parameters :
name
Required : Yes
Type : string
Location : path
Description : Required. Resource name of Agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` If the caller does not have permission to delete the agent, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the agent to delete does not exist, a `NOT_FOUND` error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}
Path : v1alpha/{+name}
Description : Deletes an Agent.
HTTP Method : DELETE
Scopes :
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.patch
HTTP Method : PATCH
Parameters :
updateMask
Format : google-fieldmask
Type : string
Description : Optional. The list of fields to update.
Location : query
name
Required : Yes
Location : path
Type : string
Description : Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Path : v1alpha/{+name}
Description : Updates an Agent
Scopes :
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}
▼ ▲ discoveryengine.projects.locations.collections.dataStores.widgetConfigs.patch
HTTP Method : PATCH
Parameter Order : name
Path : v1alpha/{+name}
Description : Update a WidgetConfig.
Scopes :
Parameters :
updateMask
Location : query
Format : google-fieldmask
Type : string
Description : Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
name
Required : Yes
Location : path
Type : string
Description : Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}