Create an app

Console

1. In the Google Cloud console, go to the Agentspace page.
2. On the Apps page, click Create app.
3. On the Create app page, select Agentspace.
4. In the Your app name field, enter a name for your app.
5. In the External name of your company or organization field, enter the common name for your company or organization. You don't need to include suffixes such as Inc or LLC. This field is useful for the LLM to identify the company that the app represents.

6. Select a location for your app. Google recommends that you use the default, global (Global), unless you have a reason to restrict your data to a particular geography.

7. Click Continue.

8. Optional: Add one of the following identity providers in the Identity provider field. Skip this step if you've already connected to your identity provider

   This determines what identity provider your users sign into your app with. Make sure your data source that you plan to use is on the same identity provider.

9. Add your provider:

   • Google Identity Provider: If you plan for your users to sign into your app with Google Identity, then select this option. This adds the identity provider associated with the account that you're signed into Agentspace with.
   • 3rd Party Identity: If you plan for your users to sign into your app with a third-party identity provider, enter the workforce pool that applies for your data source and click Add.

10. To attach a data store, on the Data Stores page, select the data stores to attach.

    • Select existing data stores.
    • Create one or more new data stores and ingest data into them. Do this by clicking Create data store and following the steps in the Create a new data store pane that opens. Then select your new data store. For information about importing from first-party data sources, see Create a first-party data store. For creating connectors for third-party data sources, see Connect a third-party data source.

11. Optional: To see a list of unavailable data stores, click Learn why.

    A table is displayed with a list of data stores and the reason why they are unavailable.

12. Click Create.

REST

Before you use the command line to create an app, you must have an existing data store. If you don't have a data store, you need to connect a Google data source or a third-party data source to your app.

To use the engines.create method to create an app from the command line, follow these steps:

1. Find your data store ID. If you already have your data store ID, skip to the next step.

   1. In the Google Cloud console, go to the Agentspace page and in the navigation menu, click Data Stores.

      Go to the Data Stores page

   2. Click the name of your data store.

   3. On the Data page for your data store, get the data store ID.

2. Create an app and connect it to a data store.

   curl -X POST \
   -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   -H "X-Goog-User-Project: PROJECT_ID" \
   "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines?engineId=APP_ID" \
   -d '{
     "displayName": "APP_DISPLAY_NAME",
     "dataStoreEntityIds": ["DATA_STORE_ENTITY_ID_1", "DATA_STORE_ENTITY_ID_2", "DATA_STORE_ENTITY_ID_3"],
     "solutionType": "SOLUTION_TYPE_SEARCH",
     "industryVertical": "GENERIC",
     "appType": "APP_TYPE_INTRANET"
   }'
   

   Replace the following:

   • PROJECT_ID: the ID of your project.
   • APP_ID: the ID of the app that you want to create.
   • APP_DISPLAY_NAME: the display name of the app that you want to create.
   • DATA_STORE_ENTITY_ID: if your data store contains entities, use the specific entity IDs. If your data store does not contain entities, use the data store ID instead.

   Example command and result

   curl -X POST \
   -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   -H "X-Goog-User-Project: my-project-123" \
   "https://discoveryengine.googleapis.com/v1/projects/my-project-123/locations/global/collections/default_collection/engines?engineId=my-app" \
   -d '{
     "displayName": "my-app",
     "dataStoreIds": ["slack_1234567890123_conversation", "slack_1234567890123_file", "slack_1234567890123_message"],
     "solutionType": "SOLUTION_TYPE_SEARCH",
     "industryVertical": "GENERIC",
     "appType": "APP_TYPE_INTRANET"
   }'
   
   {
     "name": "projects/123456/locations/global/collections/default_collection/operations/create-engine-12345678901234567890",
     "done": true,
     "response": {
       "@type": "type.googleapis.com/google.cloud.discoveryengine.v1.Engine",
       "name": "projects/123456/locations/global/collections/default_collection/engines/my-app",
       "displayName": "my-app",
       "dataStoreIds": [
         "slack_1234567890123_conversation",
         "slack_1234567890123_file",
         "slack_1234567890123_message"
       ],
       "solutionType": "SOLUTION_TYPE_SEARCH",
       "searchEngineConfig": {
         "searchTier": "SEARCH_TIER_STANDARD"
       },
       "industryVertical": "GENERIC",
       "appType": "APP_TYPE_INTRANET"
     }
   }