Docs
OpenDoor Search — Vertex AI Grounding with Google Search, $0.10 per query, included on Enterprise.
Search
POST /v1/plugins/web-search
POST /v1/plugins/search
Same engine. The gateway runs Vertex AI Grounding with Google Search on OpenDoor’s GCP project (provider: "vertex_google_search"). You do not paste GCP or third-party search keys. Citations come back with the synthesized answer.
GET /v1/tools lists OpenDoor Search as $0.10 / query (and the Web Search plugin as $0.10 / call).
Price
| Who | What you pay |
|---|---|
| Enterprise | Included (no per-query debit for this tool) |
| $20/month Web Search add-on | Included for the month — subscribe on Billing |
| Everyone else | Enable the tool on Dashboard → Tools, then $0.10 per query from prepaid credits |
Without entitlement the gateway returns 402:
json{ "error": "OpenDoor Search is metered on credits, or a $20/month add-on. Enable it on Tools or subscribe on Billing.", "code": "addon_required", "addon": "web_search", "amountUsd": 20 }
If the tool is enabled but the org cannot cover $0.10:
json{ "error": "OpenDoor Search needs $0.10 spendable credit. Top up on Billing." }
If Vertex is not configured on the server: 503 (not a fake empty result).
Request
| Field | Type | Required | Description |
|---|---|---|---|
query | string | Yes | Search question |
max_results | integer | No | Caps citations (server default 5, hard max 8) |
bashexport OPENDOOR_API_KEY=opd_… export OPENDOOR_BASE_URL=https://opendoor-gcp.web.app curl "$OPENDOOR_BASE_URL/v1/plugins/web-search" \ -H "Authorization: Bearer $OPENDOOR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "query": "OpenDoor LLM gateway", "max_results": 5 }'
Response
json{ "query": "OpenDoor LLM gateway", "provider": "vertex_google_search", "answer": "…", "results": [ { "title": "…", "url": "https://…", "snippet": "…" } ], "citations": [ { "title": "…", "url": "https://…", "snippet": "…" } ] }
results and citations are the same list.
SDKs
tsawait client.plugins.webSearch({ query: "OpenDoor LLM gateway", max_results: 5, });
pythonclient.plugins.web_search("OpenDoor LLM gateway", max_results=5)
There is no CLI search command. Use curl or an SDK.
Agents and workflows
Hosted agents can call the web_search tool on a turn (same Vertex engine, same $0.10 / Enterprise rules). Workflow Web Search nodes use the same entitlement check.
BYOK and GCP
Platform Search uses OpenDoor’s GCP credentials (GOOGLE_CLOUD_PROJECT + ADC on Cloud Run). Customers do not upload a service-account JSON for Search.
If you want the gateway to prefer your Vertex key for chat routing, add a vertex provider key — see BYOK. That is separate from Search billing.
Team Google / GCP on Dashboard → Team stores a project id and sync timestamp for your workspace. It does not expose secrets and it is not a Search API.