Vertex AI Search API

openapi: 3.1.0
info:
  title: Vertex AI Search API
  version: '2026-10-13'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-13: 17 operation(s) read from 13 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; Vertex AI Search has published no machine-readable
    contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 17
    documentation: 0
    pages-with-code: 13
    pages-read: 13
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-13'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://developers.google.com
  - https://docs.cloud.google.com/docs/authentication
  - https://docs.cloud.google.com/sdk/docs/install-sdk
  - https://docs.cloud.google.com/sdk/docs/downloads-interactive
  - https://docs.cloud.google.com/sdk/docs/authenticate
  - https://docs.cloud.google.com/sdk/use-gcloud-mcp
  - https://docs.cloud.google.com/sdk/docs/install
  - https://docs.cloud.google.com/docs/authentication/rest
  - https://docs.cloud.google.com/docs/authentication/api-keys-use
  - https://docs.cloud.google.com/docs/authentication/api-keys
  - https://docs.cloud.google.com/docs/authentication/get-id-token
  - https://docs.cloud.google.com/docs/authentication/token-types
  - https://developers.google.com/identity/protocols/risc
servers:
- url: https://packages.cloud.google.com
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://docs.cloud.google.com/sdk/docs/downloads-interactive
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://sdk.cloud.google.com | bash \n When prompted, choose a location on your file system for the\n google-cloud-sdk\
          \ subdirectory. The default is your Home directory.\n To send anonymous usage statistics to help improve gcloud CLI,\n answer Y when\
          \ prompted.\n To add gcloud CLI command-line tools to your PATH and enable command\n completion, answer Y when prompted.\n Restart your\
          \ shell:\n exec -l $S"
    post:
      operationId: post
      tags:
      - Api
      summary: POST /
      x-source: https://docs.cloud.google.com/sdk/use-gcloud-mcp
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://cloudcli.googleapis.com/ TOOLSET_ENDPOINT  -H 'Content-Type: application/json'  -H 'Accept: application/json'\
          \  -H 'MCP-Protocol-Version: MCP_PROTOCOL_VERSION '  -H 'Mcp-Method: tools/list'  -d '{\n \"jsonrpc\": \"2.0\",\n \"id\": 1,\n \"method\"\
          : \"tools/list\",\n \"params\": {\n \"_meta\": {\n \"io.modelcontextprotocol/protocolVersion\": \" MCP_PROTOCOL_VERSION \",\n \"io.modelcontextprotocol/clientCa"
  /apt/doc/apt-key.gpg:
    get:
      operationId: get_apt_doc_apt_key_gpg
      tags:
      - Apt
      summary: GET /apt/doc/apt-key.gpg
      x-source: https://docs.cloud.google.com/sdk/docs/install-sdk
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo gpg --dearmor -o /usr/share/keyrings/cloud.google.gpg \n For\
          \ older distributions, run the following command:"
  /auth/cloud-platform:
    get:
      operationId: get_auth_cloud_platform
      tags:
      - Auth
      summary: GET /auth/cloud-platform
      x-source: https://docs.cloud.google.com/docs/authentication
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl to\n call the REST API .\n Try out a code snippet included in my product documentation.\n Set up ADC for a local development\
          \ environment ,\n and install your product's client library in your local environment. The\n client library\n finds your credentials\
          \ automatically .\n Get help with another authentication use case. \n See the\n Authentication use cases \n page.\n See a list of the\
          \ products Google pr"
  /computeMetadata/v1/instance/service-accounts/default/{defaultid}:
    get:
      operationId: get_computeMetadata_v1_instance_service_accounts_default_defaultid
      tags:
      - Computemetadata
      summary: GET /computeMetadata/v1/instance/service-accounts/default/identity
      x-source: https://docs.cloud.google.com/docs/authentication/get-id-token
      parameters:
      - name: defaultid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetComputemetadataV1InstanceServiceAccountsDefaultDefaultidR'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -H \"Metadata-Flavor: Google\"  'http://metadata/computeMetadata/v1/instance/service-accounts/default/identity?audience=\
          \ AUDIENCE '\n PowerShell Replace AUDIENCE with the URI for the target service,\nfor example http://www.example.com . "
        collapsed_from: 2 example path(s) differing only at defaultId
  /dl/cloudsdk/channels/rapid/downloads:
    get:
      operationId: get_dl_cloudsdk_channels_rapid_downloads
      tags:
      - Dl
      summary: GET /dl/cloudsdk/channels/rapid/downloads
      x-source: https://docs.cloud.google.com/sdk/docs/install-sdk
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -O https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/ google-cloud-cli-linux-x86_64.tar.gz \n Refer to the table\
          \ above and replace google-cloud-cli-linux-x86_64.tar.gz with the\n *.tar.gz package name that applies to your configuration.\n To extract\
          \ the contents of the file to your file system, run the following command:\n tar -xf google-cloud-cli-linux-x86_64.tar.gz \n To replace\
          \ an exis"
  /dl/cloudsdk/channels/rapid/downloads/:
    get:
      operationId: get_dl_cloudsdk_channels_rapid_downloads
      tags:
      - Dl
      summary: 'Download one of the following:'
      x-source: https://docs.cloud.google.com/sdk/docs/install-sdk
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /drive/v3/files:
    get:
      operationId: get_drive_v3_files
      tags:
      - Drive
      summary: GET /drive/v3/files
      x-source: https://docs.cloud.google.com/sdk/docs/authenticate
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -H \"Authorization: Bearer $( gcloud auth print-access-token ) \"  \"https://www.googleapis.com/drive/v3/files\" \n Windows\
          \ (PowerShell) Invoke-WebRequest ` \n -Method GET ` \n -Headers @ { \"Authorization\" = \"Bearer $( gcloud auth print-access-token )\
          \ \" } ` \n -ContentType \"application/json; charset=utf-8\" ` \n -UseBasicParsing ` \n -Uri \"https://www.googleapis.com/drive/v3/files\"\
          \ | Select-Object -Expa"
  /language/translate/v2:
    post:
      operationId: post_language_translate_v2
      tags:
      - Language
      summary: POST /language/translate/v2
      x-source: https://docs.cloud.google.com/docs/authentication/rest
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST  -H \"X-goog-api-key: API_KEY \"  -H \"Content-Type: application/json; charset=utf-8\"  -d @request.json  \"https://translation.googleapis.com/language/translate/v2\"\
          \n If you can't use the HTTP header, you can use the key query parameter.\nHowever, this method includes your API key in the URL, exposing\
          \ your key to\ntheft through URL scans. \n The following example shows how to use the key quer"
  /tokeninfo:
    get:
      operationId: get_tokeninfo
      tags:
      - Tokeninfo
      summary: GET /tokeninfo
      x-source: https://docs.cloud.google.com/docs/authentication/token-types
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTokeninfoResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl \"https://oauth2.googleapis.com/tokeninfo?access_token= ACCESS_TOKEN \" \n This command produces output similar to the\
          \ following example: \n { \n \"azp\" : \"0000000000.apps.googleusercontent.com\" , \n \"aud\" : \"0000000000.apps.googleusercontent.com\"\
          \ , \n \"sub\" : \"00000000000000000000\" , \n \"scope\" : \"openid https://www.googleapis.com/auth/userinfo.email\" , \n \"exp\" :\
          \ \"1744687132\" , \n \"expires_in\" : \"3568"
  /v1/documents{analyzeEntities}:
    post:
      operationId: post_v1_documents_analyzeEntities
      tags:
      - Documents Analyzeentities
      summary: POST https://language.googleapis.com/v1/documents:analyzeEntities?key=API_KEY
      x-source: https://docs.cloud.google.com/docs/authentication/rest
      parameters:
      - name: analyzeEntities
        in: path
        required: true
        schema:
          type: string
      - name: key
        in: query
        required: true
        schema:
          type: string
        description: API key string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/projects/-/serviceAccounts:
    post:
      operationId: post_v1_projects_serviceAccounts
      tags:
      - Projects
      summary: POST /v1/projects/-/serviceAccounts
      x-source: https://docs.cloud.google.com/docs/authentication/get-id-token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1ProjectsServiceaccountsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST  -H \"Authorization: Bearer $( gcloud auth print-access-token ) \"  -H \"Content-Type: application/json\"  -d '{\"\
          audience\": \" AUDIENCE \", \"includeEmail\": \"true\"}'  https://iamcredentials.googleapis.com/v1/projects/-/serviceAccounts/ SERVICE_ACCOUNT_EMAIL\
          \ :generateIdToken\n Generate a generic ID token for development with Cloud Run and Cloud Run functions \n You can use the gcloud CLI\
          \ to get"
  /v1beta/models/gemini-3-5-flash{generateContent}:
    post:
      operationId: post_v1beta_models_gemini_3_5_flash_generateContent
      tags:
      - V1Beta
      summary: POST /v1beta/models/gemini-3-5-flash:generateContent
      x-source: https://developers.google.com
      parameters:
      - name: generateContent
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1BetaModelsGemini35FlashGeneratecontentRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl \"https://generativelanguage.googleapis.com/v1beta/models/gemini-3-5-flash:generateContent\"  -H \"x-goog-api-key: $GEMINI_API_KEY\
          \ \"  -H 'Content-Type: application/json'  -X POST  -d '{ \n \"contents\": [ \n { \n \"parts\": [ \n { \n \"text\": \"Explain how AI\
          \ works in a few words\" \n } \n ] \n } \n ] \n }' \n News & Announcements \n Google Play \n Tools for discovery and engagement on Google\
          \ Play \n add \n remove \n "
  /v1beta/stream{update}:
    post:
      operationId: post_v1beta_stream_update
      tags:
      - V1Beta
      summary: POST /v1beta/stream:update
      x-source: https://developers.google.com/identity/protocols/risc
      parameters:
      - name: update
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: http
        snippet: "POST /v1beta/stream:update HTTP/1.1\nHost: risc.googleapis.com\nAuthorization: Bearer AUTH_TOKEN \n{\n \"delivery\": {\n \"\
          delivery_method\":\n \"https://schemas.openid.net/secevent/risc/delivery-method/push\",\n \"url\": RECEIVER_ENDPOINT \n },\n \"events_requested\"\
          : [\n SECURITY_EVENT_TYPES \n ]\n}\n For example: \n Java public static void configureEventStream ( final String receiverEndpoint ,\
          \ \n final List<String> eve"
  /v2/projects:
    post:
      operationId: post_v2_projects
      tags:
      - Projects
      summary: POST /v2/projects
      x-source: https://docs.cloud.google.com/docs/authentication/api-keys
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV2ProjectsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST  -H \"Authorization: Bearer $( gcloud auth print-access-token ) \"  -H \"Content-Type: application/json; charset=utf-8\"\
          \  -d '{ \n \"displayName\" : \" DISPLAY_NAME \", \n \"restrictions\" : { \n \"apiTargets\": [ \n { \n \"service\": \" SERVICE_1 \"\
          \ \n }, \n { \n \"service\" : \" SERVICE_2 \" \n }, \n ] \n } \n }'  \"https://apikeys.googleapis.com/v2/projects/ PROJECT_ID /locations/global/keys\"\
          \ \n Replace the followi"
  /v2/{v2id}:
    get:
      operationId: get_v2_v2id
      tags:
      - Api
      summary: GET /v2/keys:lookupKey
      x-source: https://docs.cloud.google.com/docs/authentication/api-keys
      parameters:
      - name: v2id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl - X GET  - H \"Authorization: Bearer $(gcloud auth print-access-token)\"  - H \"Content-Type: application/json; charset=utf-8\"\
          \  \"https://apikeys.googleapis.com/v2/keys:lookupKey?keyString= KEY_STRING \" \n Create a copy of an API key \n If you need a new API\
          \ key with the same restrictions as an existing API key, you\ncan create a copy of the existing API key. This operation creates a new\
          \ API key\nwit"
        collapsed_from: 2 example path(s) differing only at v2Id
  /v3/projects:
    get:
      operationId: get_v3_projects
      tags:
      - Projects
      summary: GET /v3/projects
      x-source: https://docs.cloud.google.com/docs/authentication/rest
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X GET \\ -H \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudresourcemanager.googleapis.com/v3/projects/\
          \ PROJECT_ID \" \n PowerShell \n Execute the following command:"
components:
  schemas:
    PostRequest:
      type: object
      properties:
        jsonrpc:
          type: string
        id:
          type: integer
        method:
          type: string
        params:
          type: object
          properties:
            _meta:
              type: object
              properties:
                io.modelcontextprotocol/protocolVersion:
                  type: string
                io.modelcontextprotocol/clientCapabilities:
                  type: object
                  properties:
                    extensions:
                      type: object
                      properties:
                        io.modelcontextprotocol/ui:
                          type: object
                          properties:
                            mimeTypes:
                              type: array
                              items: {}
    GetComputemetadataV1InstanceServiceAccountsDefaultDefaultidR:
      type: object
      properties:
        access_token:
          type: string
        expires_in:
          type: integer
        token_type:
          type: string
    GetTokeninfoResponse:
      type: object
      properties:
        azp:
          type: string
        aud:
          type: string
        scope:
          type: string
        exp:
          type: string
        expires_in:
          type: string
        email:
          type: string
        email_verified:
          type: string
        access_type:
          type: string
    PostV1ProjectsServiceaccountsRequest:
      type: object
      properties:
        audience:
          type: string
        includeEmail:
          type: string
    PostV1BetaModelsGemini35FlashGeneratecontentRequest:
      type: object
      properties:
        contents:
          type: array
          items:
            type: object
            properties:
              parts:
                type: array
                items:
                  type: object
                  properties:
                    text:
                      type: string
    PostV2ProjectsRequest:
      type: object
      properties:
        displayName:
          type: string
        restrictions:
          type: object
          properties:
            apiTargets:
              type: array
              items:
                type: object
                properties:
                  service:
                    type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Apt
- name: Auth
- name: Computemetadata
- name: Dl
- name: Documents Analyzeentities
- name: Drive
- name: Language
- name: Projects
- name: Tokeninfo
- name: V1Beta