Google

Discovery Engine API

Discovery Engine API.

Developer tools#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Discovery Engine API.

Endpoints 85

billingAccounts.billingAccountLicenseConfigs

  • POSTDistributes a LicenseConfig from billing account level to project level./v1/:billingAccountLicenseConfig:distributeLicenseConfigDistributes a LicenseConfig from billing account level to project level.
  • POSTThis method is called from the billing account side to retract the LicenseConfig from the given project back to the…/v1/:billingAccountLicenseConfig:retractLicenseConfigThis method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.

projects.locations

  • POSTProvisions the project resource/v1/:name:provisionProvisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the Terms for data use, and…
  • POSTCreates a Collection and sets up the DataConnector for it/v1/:parent:setUpDataConnectorCreates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.
  • POSTCreates a Collection and sets up the DataConnector for it/v1/:parent:setUpDataConnectorV2?collectionDisplayName=string&collectionId=stringCreates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.

projects.operations

  • GETGets the latest state of a long-running operation/v1/:nameGets 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.
  • GETLists operations that match the specified filter in the request/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
  • POSTStarts asynchronous cancellation on a long-running operation/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the…

projects.locations.identityMappingStores

  • DELETEDeletes the Identity Mapping Store./v1/:nameDeletes the Identity Mapping Store.
  • GETLists all Identity Mapping Stores./v1/:parent/identityMappingStores?pageSize=0&pageToken=stringLists all Identity Mapping Stores.
  • POSTCreates a new Identity Mapping Store./v1/:parent/identityMappingStores?cmekConfigName=string&disableCmek=true&identityMappingStoreId=stringCreates a new Identity Mapping Store.
  • POSTImports a list of Identity Mapping Entries to an Identity Mapping Store./v1/:identityMappingStore:importIdentityMappingsImports a list of Identity Mapping Entries to an Identity Mapping Store.
  • GETLists Identity Mappings in an Identity Mapping Store./v1/:identityMappingStore:listIdentityMappings?pageSize=0&pageToken=stringLists Identity Mappings in an Identity Mapping Store.
  • POSTPurges specified or all Identity Mapping Entries from an Identity Mapping Store./v1/:identityMappingStore:purgeIdentityMappingsPurges specified or all Identity Mapping Entries from an Identity Mapping Store.

projects.locations.userStores

  • PATCHUpdates the User Store./v1/:name?updateMask=stringUpdates the User Store.
  • POSTUpdates the User License/v1/:parent:batchUpdateUserLicensesUpdates the User License. This method is used for batch assign/unassign licenses to users.

projects.locations.cmekConfigs

  • GETLists all the CmekConfigs with the project./v1/:parent/cmekConfigsLists all the CmekConfigs with the project.

projects.locations.dataStores

  • GETGets the IAM access control policy for a DataStore/v1/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the IAM access control policy for a DataStore. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource…
  • POSTSets the IAM access control policy for a DataStore/v1/:resource:setIamPolicySets the IAM access control policy for a DataStore. A NOT_FOUND error is returned if the resource does not exist. Important: When setting a policy directly on…
  • GETCompletes the specified user input with keyword suggestions./v1/:dataStore:completeQuery?includeTailSuggestions=true&query=string&queryModel=string&userPseudoId=stringCompletes the specified user input with keyword suggestions.
  • GETLists all the DataStores associated with the project./v1/:parent/dataStores?filter=string&pageSize=0&pageToken=stringLists all the DataStores associated with the project.
  • POSTCreates a DataStore/v1/:parent/dataStores?cmekConfigName=string&createAdvancedSiteSearch=true&dataStoreId=string&disableCmek=true&skipDefaultSchemaCreation=trueCreates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created…

projects.locations.collections.dataConnector

  • DELETEServeMcpDeleteRequest serves a MCP DELETE request./v1/projects/:projectsId/locations/:locationsId/collections/:collectionsId/dataConnector/mcp?contentType=string&data=string&extensions={}ServeMcpDeleteRequest serves a MCP DELETE request.

projects.locations.collections.dataStores

  • POSTTrains a custom model./v1/:dataStore:trainCustomModelTrains a custom model.

projects.locations.dataStores.branches

  • GETGets index freshness metadata for Documents/v1/:parent/batchGetDocumentsMetadata?matcher.fhirMatcher.fhirResources=string&matcher.urisMatcher.uris=stringGets index freshness metadata for Documents. Supported for website search only.

projects.locations.dataStores.branches.documents

  • GETGets a list of Documents./v1/:parent/documents?pageSize=0&pageToken=stringGets a list of Documents.
  • POSTCreates a Document./v1/:parent/documents?documentId=stringCreates a Document.
  • POSTBulk import of multiple Documents/v1/:parent/documents:importBulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents…
  • POSTPermanently deletes all selected Documents in a branch/v1/:parent/documents:purgePermanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can…

projects.locations.dataStores.completionConfig

  • POSTCompletes the user input with advanced keyword suggestions./v1/:completionConfig:completeQueryCompletes the user input with advanced keyword suggestions.

projects.locations.dataStores.completionSuggestions

  • POSTImports CompletionSuggestions for a DataStore./v1/:parent/completionSuggestions:importImports CompletionSuggestions for a DataStore.
  • POSTPermanently deletes all CompletionSuggestions for a DataStore./v1/:parent/completionSuggestions:purgePermanently deletes all CompletionSuggestions for a DataStore.

projects.locations.dataStores.controls

  • GETLists all Controls by their parent DataStore./v1/:parent/controls?filter=string&pageSize=0&pageToken=stringLists all Controls by their parent DataStore.
  • POSTCreates a Control/v1/:parent/controls?controlId=stringCreates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already…

projects.locations.dataStores.conversations

  • POSTConverses a conversation./v1/:name:converseConverses a conversation.
  • GETLists all Conversations by their parent DataStore./v1/:parent/conversations?filter=string&orderBy=string&pageSize=0&pageToken=stringLists all Conversations by their parent DataStore.
  • POSTCreates a Conversation/v1/:parent/conversationsCreates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.

projects.locations.collections.dataStores.customModels

  • GETGets a list of all the custom models./v1/:dataStore/customModelsGets a list of all the custom models.

projects.locations.dataStores.schemas

  • GETGets a list of Schemas./v1/:parent/schemas?pageSize=0&pageToken=stringGets a list of Schemas.
  • POSTCreates a Schema./v1/:parent/schemas?schemaId=stringCreates a Schema.

projects.locations.dataStores.servingConfigs

  • POSTAnswer query method./v1/:servingConfig:answerAnswer query method.
  • GETLists all ServingConfigs linked to this dataStore./v1/:parent/servingConfigs?pageSize=0&pageToken=stringLists all ServingConfigs linked to this dataStore.
  • POSTCreates a ServingConfig/v1/:parent/servingConfigs?servingConfigId=stringCreates a ServingConfig. Note: The Google Cloud console works only with the default serving config. Additional ServingConfigs can be created and managed only…
  • POSTMakes a recommendation, which requires a contextual user event./v1/:servingConfig:recommendMakes a recommendation, which requires a contextual user event.
  • POSTPerforms a search./v1/:servingConfig:searchPerforms a search.
  • POSTPerforms a search/v1/:servingConfig:searchLitePerforms a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not…
  • POSTAnswer query method (streaming)/v1/:servingConfig:streamAnswerAnswer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.

projects.locations.dataStores.sessions

  • GETLists all Sessions by their parent DataStore./v1/:parent/sessions?filter=string&orderBy=string&pageSize=0&pageToken=stringLists all Sessions by their parent DataStore.
  • POSTCreates a Session/v1/:parent/sessions?sessionId=stringCreates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.

projects.locations.collections.dataStores.siteSearchEngine

  • POSTVerify target sites' ownership and validity/v1/:parent:batchVerifyTargetSitesVerify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.
  • GETReturns list of target sites with its domain verification status/v1/:siteSearchEngine:fetchDomainVerificationStatus?pageSize=0&pageToken=stringReturns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment.

projects.locations.dataStores.siteSearchEngine

  • POSTDowngrade from advanced site search to basic site search./v1/:siteSearchEngine:disableAdvancedSiteSearchDowngrade from advanced site search to basic site search.
  • POSTUpgrade from basic site search to advanced site search./v1/:siteSearchEngine:enableAdvancedSiteSearchUpgrade from basic site search to advanced site search.
  • POSTRequest on-demand recrawl for a list of URIs./v1/:siteSearchEngine:recrawlUrisRequest on-demand recrawl for a list of URIs.

projects.locations.dataStores.siteSearchEngine.sitemaps

  • POSTCreates a Sitemap./v1/:parent/sitemapsCreates a Sitemap.
  • GETFetch Sitemaps in a DataStore./v1/:parent/sitemaps:fetch?matcher.urisMatcher.uris=stringFetch Sitemaps in a DataStore.

projects.locations.dataStores.siteSearchEngine.targetSites

  • POSTCreates TargetSite in a batch./v1/:parent/targetSites:batchCreateCreates TargetSite in a batch.
  • GETGets a list of TargetSites./v1/:parent/targetSites?pageSize=0&pageToken=stringGets a list of TargetSites.
  • POSTCreates a TargetSite./v1/:parent/targetSitesCreates a TargetSite.

projects.locations.dataStores.suggestionDenyListEntries

  • POSTImports all SuggestionDenyListEntry for a DataStore./v1/:parent/suggestionDenyListEntries:importImports all SuggestionDenyListEntry for a DataStore.
  • POSTPermanently deletes all SuggestionDenyListEntry for a DataStore./v1/:parent/suggestionDenyListEntries:purgePermanently deletes all SuggestionDenyListEntry for a DataStore.

projects.locations.userEvents

  • GETWrites a single user event from the browser/v1/:parent/userEvents:collect?ets=string&uri=string&userEvent=stringWrites a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used…
  • POSTBulk import of user events/v1/:parent/userEvents:importBulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user…
  • POSTWrites a single user event./v1/:parent/userEvents:write?writeAsync=trueWrites a single user event.

projects.locations.dataStores.userEvents

  • POSTDeletes permanently all user events specified by the filter provided/v1/:parent/userEvents:purgeDeletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take…

projects.locations.collections.engines

  • GETLists all the Engines associated with the project./v1/:parent/engines?filter=string&pageSize=0&pageToken=stringLists all the Engines associated with the project.
  • POSTCreates an Engine./v1/:parent/engines?engineId=stringCreates an Engine.

projects.locations.collections.engines.assistants

  • GETLists all Assistants under an Engine./v1/:parent/assistants?pageSize=0&pageToken=stringLists all Assistants under an Engine.
  • POSTCreates an Assistant./v1/:parent/assistants?assistantId=stringCreates an Assistant.
  • POSTAssists the user with a query in a streaming fashion./v1/:name:streamAssistAssists the user with a query in a streaming fashion.

projects.locations.collections.engines.assistants.agents.a2a.v1

  • GETGetAgentCard returns the agent card for the agent./v1/:tenant/a2a/v1/cardGetAgentCard returns the agent card for the agent.

projects.locations.collections.engines.assistants.agents.a2a.v1.message

  • POSTSend a message to the agent/v1/:tenant/a2a/v1/message:sendSend a message to the agent. This is a blocking call that will return the task once it is completed, or a LRO if requested.
  • POSTSendStreamingMessage is a streaming call that will return a stream of task update events until the Task is in an…/v1/:tenant/a2a/v1/message:streamSendStreamingMessage is a streaming call that will return a stream of task update events until the Task is in an interrupted or terminal state.

projects.locations.collections.engines.assistants.agents.a2a.v1.tasks

  • POSTCancel a task from the agent/v1/:tenant/a2a/v1/:name:cancelCancel a task from the agent. If supported one should expect no more task updates for the task.
  • GETTaskSubscription is a streaming call that will return a stream of task update events/v1/:tenant/a2a/v1/:name:subscribeTaskSubscription is a streaming call that will return a stream of task update events. This attaches the stream to an existing in process task. If the task is…

projects.locations.collections.engines.assistants.agents.a2a.v1.tasks.pushNotificationConfigs

  • GETGet a push notification config for a task./v1/:tenant/a2a/v1/:nameGet a push notification config for a task.
  • DELETEDelete a push notification config for a task./v1/:tenant/a2a/v1/:nameDelete a push notification config for a task.
  • POSTSet a push notification config for a task./v1/:tenant/a2a/v1/:parent?configId=stringSet a push notification config for a task.
  • GETGet a list of push notifications configured for a task./v1/:tenant/a2a/v1/:parent/pushNotificationConfigs?pageSize=0&pageToken=stringGet a list of push notifications configured for a task.

projects.locations.groundingConfigs

  • POSTPerforms a grounding check./v1/:groundingConfig:checkPerforms a grounding check.

projects.locations.licenseConfigs

  • GETLists all the LicenseConfigs associated with the project./v1/:parent/licenseConfigs?filter=string&pageSize=0&pageToken=stringLists all the LicenseConfigs associated with the project.
  • POSTCreates a LicenseConfig This method should only be used for creating NotebookLm licenses or Gemini Enterprise free…/v1/:parent/licenseConfigs?licenseConfigId=stringCreates a LicenseConfig This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses.

projects.locations.rankingConfigs

  • POSTRanks a list of text records based on the given input query./v1/:rankingConfig:rankRanks a list of text records based on the given input query.

projects.locations.userStores.licenseConfigsUsageStats

  • GETLists all the LicenseConfigUsageStatss associated with the project./v1/:parent/licenseConfigsUsageStatsLists all the LicenseConfigUsageStatss associated with the project.

projects.locations.userStores.userLicenses

  • GETLists the User Licenses./v1/:parent/userLicenses?filter=string&orderBy=string&pageSize=0&pageToken=stringLists the User Licenses.

API details

Base URL
https://discoveryengine.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 5 scopes
An API key in the key query parameter
Operations
85 operations on 70 pathsPOST 52GET 29DELETE 3PATCH 1
Main resources
projects.locations.collections.engines.assistants.agents.a2… 9projects.locations.dataStores.servingConfigs 7projects.locations.identityMappingStores 6projects.locations.dataStores 5projects.locations.dataStores.branches.documents 4projects.locations 3projects.locations.collections.engines.assistants 3projects.locations.dataStores.conversations 3projects.locations.dataStores.siteSearchEngine 3projects.locations.dataStores.siteSearchEngine.targetSites 3
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Discovery Engine API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Discovery Engine API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 5 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Distributes a LicenseConfig from billing account level to project level.” (POST /v1/:billingAccountLicenseConfig:distributeLicenseConfig), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Discovery Engine API?

Discovery Engine API. It is listed under Developer tools and has 85 endpoints.

Who publishes the Discovery Engine API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Discovery Engine API?

Requests go to https://discoveryengine.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Discovery Engine API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 5 scopes; an API key in the key query parameter.

How many endpoints does the Discovery Engine API have?

85 operations on 70 paths (52 POST, 29 GET, 3 DELETE, 1 PATCH). The largest groups are projects.locations.collections.engines.assistants.agents.a2…, projects.locations.dataStores.servingConfigs, projects.locations.identityMappingStores, projects.locations.dataStores.

Is forking the Discovery Engine API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.