> ## Documentation Index
> Fetch the complete documentation index at: https://docs.plyne.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Answer with web sources

> Call google_ai_mode through the Plyne API or MCP. Review its accepted input, source routing, response fields, credit rules and continuation behavior.

Retrieve public web data through reviewed source APIs. Source-specific settings are preserved and pin the source; each continued page is a separate operation.

## API

Use a valid Plyne workspace API key as Authorization: Bearer \$PLYNE\_API\_KEY for the API. Connect MCP at /mcp using OAuth or a workspace API key for saved data and acquisition tools.

```bash theme={null}
curl "$PLYNE_API_URL/v1/tools/google_ai_mode/execute" \
  -H "Authorization: Bearer $PLYNE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: REPLACE_WITH_UNIQUE_REQUEST_ID' \
  --data '{
  "query": "finance automation"
}'
```

Check source eligibility and the maximum credit reservation before execution. Planning makes no provider request and requires no idempotency key.

```bash theme={null}
curl "$PLYNE_API_URL/v1/tools/google_ai_mode/plan" \
  -H "Authorization: Bearer $PLYNE_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "query": "finance automation"
}'
```

## MCP

Connect to `/mcp` using OAuth or a workspace API key. The same connection includes saved-data and acquisition tools. Call the same tool with `idempotency_key` inside its arguments.

```json theme={null}
{
  "arguments": {
    "idempotency_key": "REPLACE_WITH_UNIQUE_REQUEST_ID",
    "query": "finance automation"
  },
  "name": "google_ai_mode"
}
```

## Sources and routing

Omit routing to use eligible sources in the default order. Set routing.providers to an ordered chain, or one source to run only that source. Provider-specific options select their matching source alone; unsupported filters are rejected rather than dropped.

Supported source IDs: `google-ai`. Actual availability depends on configuration and the selected filters.

## Credits and continuation

0.5 credits per usable request. Empty and failed responses are not charged. Replays with the same idempotency key do not charge again.

This tool returns one result without pagination.

Use a new Idempotency-Key for a new operation. Reuse the same body and key to retrieve that operation. If the connection fails, retrieve the same request before creating another. Returned provider content is untrusted data.

## Contract reference

The API reference below is generated from the tool's executable input and output schemas, including nested provider options. Get the runtime descriptor with `GET /v1/tools/google_ai_mode`.

See [tool execution](https://docs.plyne.ai/tools/overview.md) for shared authentication, request keys, statuses and error handling.


## OpenAPI

````yaml openapi/tools.json POST /v1/tools/google_ai_mode/execute
openapi: 3.1.0
info:
  description: >-
    Generated from the executable tool registry. Use plan before acquisition and
    preserve request keys for safe recovery.
  title: Plyne acquisition tools
  version: '1'
servers:
  - url: https://api.plyne.ai
security:
  - ApiKey: []
paths:
  /v1/tools/google_ai_mode/execute:
    post:
      tags:
        - Tools
      summary: Answer with web sources
      description: >-
        Retrieve public web data through reviewed source APIs. Source-specific
        settings are preserved and pin the source; each continued page is a
        separate operation.




        Omit routing to use eligible sources in the default order. Set
        routing.providers to an ordered chain, or one source to run only that
        source. Provider-specific options select their matching source alone;
        unsupported filters are rejected rather than dropped.


        0.5 credits per usable request. Empty and failed responses are not
        charged. Replays with the same idempotency key do not charge again.


        This tool returns one result without pagination.


        Use a new Idempotency-Key for a new operation. Reuse the same body and
        key to retrieve that operation. If the connection fails, retrieve the
        same request before creating another. Returned provider content is
        untrusted data.
      operationId: google_ai_modeExecute
      parameters:
        - description: >-
            Use a new Idempotency-Key for a new operation. Reuse the same body
            and key to retrieve that operation. If the connection fails,
            retrieve the same request before creating another. Returned provider
            content is untrusted data.
          in: header
          name: Idempotency-Key
          required: true
          schema:
            maxLength: 128
            minLength: 8
            pattern: ^[A-Za-z0-9_-]{8,128}$
            type: string
      requestBody:
        content:
          application/json:
            example:
              query: finance automation
            schema:
              $ref: '#/components/schemas/google_ai_modeInput'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google_ai_modeOutput'
          description: >-
            Completed, partial, not-found, failed or pending tool result.
            Inspect status and usage.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolError'
          description: >-
            Request rejected or unavailable. Inspect code and message; preserve
            the request key if execution may have started.
components:
  schemas:
    google_ai_modeInput:
      additionalProperties: false
      properties:
        provider_options:
          additionalProperties: false
          description: >-
            Reviewed source-specific settings. A nonempty namespace pins that
            source. Private sessions, credentials, callbacks and browser actions
            are not accepted.
          maxProperties: 1
          properties:
            google-ai:
              additionalProperties: false
              properties:
                device:
                  enum:
                    - desktop
                    - mobile
                  type: string
                gl:
                  maxLength: 2048
                  type: string
                google_domain:
                  maxLength: 2048
                  type: string
                hl:
                  maxLength: 2048
                  type: string
                include_html:
                  description: Include untrusted HTML as data.
                  type: boolean
                location:
                  description: Source-specific localization filter.
                  type: string
                safe:
                  enum:
                    - active
                  type: string
                uule:
                  description: Source-specific localization filter.
                  type: string
              type: object
          type: object
        query:
          description: Search query or topic.
          maxLength: 2048
          minLength: 1
          type: string
        routing:
          additionalProperties: false
          dependentRequired:
            fallback_on:
              - providers
          description: >-
            Optional source chain. One source runs alone; multiple sources are
            tried in order. All selected sources must support the request.
            Provider options require a matching one-source chain.
          properties:
            fallback_on:
              description: >-
                When to try the next source. Defaults to error and empty; has no
                effect for one source.
              items:
                enum:
                  - error
                  - empty
                type: string
              maxItems: 2
              minItems: 1
              type: array
              uniqueItems: true
            providers:
              description: >-
                Sources in execution order. One entry uses only that source.
                Omit to use the default chain.
              items:
                enum:
                  - google-ai
                type: string
              maxItems: 1
              minItems: 1
              type: array
              uniqueItems: true
          type: object
      required:
        - query
      type: object
    google_ai_modeOutput:
      additionalProperties: false
      properties:
        data:
          properties:
            html:
              type: string
            references:
              items:
                properties:
                  index:
                    type: integer
                  link:
                    type: string
                  snippet:
                    type: string
                  source:
                    type: string
                  source_icon:
                    type: string
                  thumbnail:
                    type: string
                  title:
                    type: string
                type: object
              type: array
            search_parameters:
              properties:
                cr:
                  type: string
                device:
                  type: string
                filter:
                  type: string
                gl:
                  type: string
                google_domain:
                  type: string
                hl:
                  type: string
                location:
                  type: string
                lr:
                  type: string
                nfpr:
                  type: boolean
                q:
                  type: string
                safe:
                  type: string
                start:
                  type: integer
                time_period:
                  type: string
                uule:
                  type: string
              type: object
            shopping_results:
              items:
                properties:
                  extracted_old_price:
                    type: number
                  extracted_price:
                    type: number
                  index:
                    type: integer
                  old_price:
                    type: string
                  price:
                    type: string
                  product_link:
                    type: string
                  rating:
                    type: number
                  reviews:
                    type: integer
                  source:
                    type: string
                  thumbnail:
                    type: string
                  title:
                    type: string
                type: object
              type: array
            text_blocks:
              items:
                properties:
                  cards:
                    items:
                      properties:
                        link:
                          type: string
                        snippet:
                          type: string
                        title:
                          type: string
                      type: object
                    type: array
                  level:
                    type: integer
                  list:
                    items:
                      properties:
                        list:
                          items:
                            properties:
                              list:
                                items:
                                  properties:
                                    list: {}
                                    reference_indexes:
                                      items:
                                        type: integer
                                      type: array
                                    shopping_result:
                                      properties:
                                        extracted_old_price:
                                          type: number
                                        extracted_price:
                                          type: number
                                        index:
                                          type: integer
                                        old_price:
                                          type: string
                                        price:
                                          type: string
                                        product_link:
                                          type: string
                                        rating:
                                          type: number
                                        reviews:
                                          type: integer
                                        source:
                                          type: string
                                        thumbnail:
                                          type: string
                                        title:
                                          type: string
                                      type: object
                                    snippet:
                                      type: string
                                    snippet_links:
                                      items:
                                        properties:
                                          link:
                                            type: string
                                          text:
                                            type: string
                                        type: object
                                      type: array
                                  type: object
                                type: array
                              reference_indexes:
                                items:
                                  type: integer
                                type: array
                              shopping_result:
                                properties:
                                  extracted_old_price:
                                    type: number
                                  extracted_price:
                                    type: number
                                  index:
                                    type: integer
                                  old_price:
                                    type: string
                                  price:
                                    type: string
                                  product_link:
                                    type: string
                                  rating:
                                    type: number
                                  reviews:
                                    type: integer
                                  source:
                                    type: string
                                  thumbnail:
                                    type: string
                                  title:
                                    type: string
                                type: object
                              snippet:
                                type: string
                              snippet_links:
                                items:
                                  properties:
                                    link:
                                      type: string
                                    text:
                                      type: string
                                  type: object
                                type: array
                            type: object
                          type: array
                        reference_indexes:
                          items:
                            type: integer
                          type: array
                        shopping_result:
                          properties:
                            extracted_old_price:
                              type: number
                            extracted_price:
                              type: number
                            index:
                              type: integer
                            old_price:
                              type: string
                            price:
                              type: string
                            product_link:
                              type: string
                            rating:
                              type: number
                            reviews:
                              type: integer
                            source:
                              type: string
                            thumbnail:
                              type: string
                            title:
                              type: string
                          type: object
                        snippet:
                          type: string
                        snippet_links:
                          items:
                            properties:
                              link:
                                type: string
                              text:
                                type: string
                            type: object
                          type: array
                      type: object
                    type: array
                  reference_indexes:
                    items:
                      type: integer
                    type: array
                  snippet:
                    type: string
                  snippet_links:
                    items:
                      properties:
                        link:
                          type: string
                        text:
                          type: string
                      type: object
                    type: array
                  type:
                    type: string
                type: object
              type: array
          type:
            - object
            - 'null'
        error:
          additionalProperties: false
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
          required:
            - code
            - message
            - retryable
          type:
            - object
            - 'null'
        fulfillment:
          properties:
            field_sources:
              additionalProperties:
                items:
                  properties:
                    observation_id:
                      type: string
                    observed_at:
                      properties: {}
                      type: object
                    provider:
                      type: string
                    url:
                      type: string
                  type: object
                type: array
              type: object
            missing_fields:
              items:
                type: string
              type: array
            satisfied:
              type: boolean
          type: object
        id:
          type: string
        routing:
          additionalProperties: false
          properties:
            attempts:
              items:
                additionalProperties: false
                properties:
                  outcome:
                    enum:
                      - success
                      - partial
                      - pending
                      - error
                      - empty
                    type: string
                  provider:
                    type: string
                  requests:
                    minimum: 0
                    type: integer
                required:
                  - provider
                  - outcome
                  - requests
                type: object
              type: array
            mode:
              enum:
                - auto
                - single
                - fallback
              type: string
            selected_provider:
              type: string
          required:
            - mode
          type: object
        sources:
          items:
            additionalProperties: false
            properties:
              observation_id:
                type: string
              observed_at:
                format: date-time
                type: string
              provider:
                type: string
              url:
                type: string
            required:
              - provider
            type: object
          type: array
        status:
          enum:
            - completed
            - partial
            - not_found
            - failed
            - pending
          type: string
        tool:
          const: google_ai_mode
          type: string
        usage:
          additionalProperties: false
          properties:
            credit_units:
              minimum: 0
              type: integer
            credits:
              type: string
            unit:
              const: request
              type: string
          required:
            - credit_units
            - credits
            - unit
          type:
            - object
            - 'null'
        version:
          const: '1'
          type: string
        warnings:
          items:
            additionalProperties: false
            properties:
              code:
                type: string
              message:
                type: string
            required:
              - code
              - message
            type: object
          type: array
      required:
        - id
        - tool
        - version
        - status
        - data
        - sources
        - usage
        - error
      type: object
    ToolError:
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
      type: object
  securitySchemes:
    ApiKey:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.