2025-11-19
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.create
Path : v1beta/{+parent}/assistants
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location : path
Required : Yes
Type : string
assistantId
Description : Required. The ID to use for the Assistant, which will become the final component of the Assistant's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Creates an Assistant.
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.delete
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. Resource name of Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` If the caller does not have permission to delete the Assistant, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Assistant to delete does not exist, a NOT_FOUND error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Deletes an Assistant.
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.list
Path : v1beta/{+parent}/assistants
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Maximum number of Assistants to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token ListAssistantsResponse.next_page_token, received from a previous AssistantService.ListAssistants call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAssistants must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Lists all Assistants under an Engine.
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.operations.get
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ discoveryengine.projects.locations.userStores.userLicenses.list
Parameters :
orderBy
Description : Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. Redundant space characters in the syntax are insignificant. Supported fields: * `license_assignment_state` * `user_principal` * `user_profile` * `last_login_date` * `update_time` If not set, the default ordering is by `user_principal`. Examples: * `user_principal desc` to order by `user_principal` in descending order. * `license_assignment_state` to order by `license_assignment_state` in ascending order. * `last_login_date desc` to order by `last_login_date` in descending order. * `update_time desc` to order by `update_time` in descending order. * `last_login_date desc, user_principal` to order by `last_login_date` in descending order and then by `user_principal` in ascending order.
Location : query
Type : string
filter
Description : Optional. Filter for the list request. Supported fields: * `license`_`assignment`_`state` * `user_principal` * `user_profile` Examples: * `license`_`assignment`_`state = ASSIGNED` to list assigned user licenses. * `license`_`assignment`_`state = NO_LICENSE` to list not licensed users. * `license`_`assignment`_`state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license`_`assignment`_`state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.
Location : query
Type : string
▼ ▲ discoveryengine.media.download
Path : v1beta/{+name}:downloadFile
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}:downloadFile
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$
Location : path
Required : Yes
Type : string
fileId
Description : Required. The ID of the file to be downloaded.
Location : query
Type : string
viewId
Description : Optional. The ID of the view to be downloaded.
Location : query
Type : string
Parameter Order : name
Supportsmediadownload : Yes
Usemediadownloadservice : Yes
Scopes :
Description : Downloads a file from the session.