Skip to content

Update ADK doc according to issue #1438 - 13#1445

Open
adk-bot wants to merge 1 commit intomainfrom
agent-changes-20260316-014300
Open

Update ADK doc according to issue #1438 - 13#1445
adk-bot wants to merge 1 commit intomainfrom
agent-changes-20260316-014300

Conversation

@adk-bot
Copy link
Copy Markdown
Collaborator

@adk-bot adk-bot commented Mar 16, 2026

13. Document the --api_key option for adk deploy agent_engine

Doc file: docs/deploy/agent-engine/deploy.md

Current state:

The following example deploy command uses the multi_tool_agent sample code as
the project to be deployed:

PROJECT_ID=my-project-id
LOCATION_ID=us-central1
GCS_BUCKET=gs://MY-CLOUD-STORAGE-BUCKET

adk deploy agent_engine \
        --project=$PROJECT_ID \
        --region=$LOCATION_ID \
        --staging_bucket=$GCS_BUCKET \
        --display_name="My First Agent" \
        multi_tool_agent

Proposed Change:

The following example deploy command uses the multi_tool_agent sample code as
the project to be deployed:

Option 1: Deploy with Google Cloud Project (Standard)

PROJECT_ID=my-project-id
LOCATION_ID=us-central1
GCS_BUCKET=gs://MY-CLOUD-STORAGE-BUCKET

adk deploy agent_engine \
        --project=$PROJECT_ID \
        --region=$LOCATION_ID \
        --staging_bucket=$GCS_BUCKET \
        --display_name="My First Agent" \
        multi_tool_agent

Option 2: Deploy with API Key (Express Mode)

If you are using Express Mode, you can deploy using your API Key:

adk deploy agent_engine --api_key=YOUR_API_KEY my_agent

Reasoning:
The adk deploy agent_engine command now supports an --api_key argument for Express Mode deployment. This option should be documented alongside the standard Google Cloud Project deployment method.

Reference: src/google/adk/cli/cli_tools_click.py

@netlify
Copy link
Copy Markdown

netlify bot commented Mar 16, 2026

Deploy Preview for adk-docs-preview ready!

Name Link
🔨 Latest commit eb04996
🔍 Latest deploy log https://app.netlify.com/projects/adk-docs-preview/deploys/69b7602978eeca0008edab5a
😎 Deploy Preview https://deploy-preview-1445--adk-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants