Cloud Search API

Name: Cloud Search API API
Brand: Cloud Search API
Availability: InStock

✓ Official Vendor SpecProductivityCollaborationoauth245 EndpointsREST

For Agents

Index third-party documents into Google Cloud Search, run authenticated queries across Workspace and custom datasources, and read query analytics. Lets agents retrieve grounded context from an enterprise's connected content.

Quickstart

Get started with Cloud Search API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"search workspace content"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Cloud Search API API.

Index third-party items into a Cloud Search datasource with per-item ACLs

Run permission-filtered queries that scope results to the calling user's identity

Define and update structured schemas on a datasource

Inspect indexing status, errors, and item counts per datasource

GET STARTED

Start building with Cloud Search API API

Explore with Jentic

View OpenAPI Document

Use for: I need to index a custom document into Cloud Search, Search Cloud Search for items matching a query, Get the indexing status of a specific item, List all data sources configured in my Cloud Search tenant

Not supported: Does not crawl public web content, replace Drive's full-text search UI, or store documents itself — use for indexing and querying enterprise content with permission-aware retrieval only.

Cloud Search provides cloud-based search across Google Workspace data and lets enterprises index third-party content alongside it. The API exposes datasource and schema management, item indexing, query execution, and search analytics so internal apps can deliver Google-quality search over Drive, Gmail, Calendar, and custom corpora. It is the backbone for enterprise search portals, intranet copilots, and federated retrieval across SaaS systems mapped into a single index.

Use Cases

Patterns agents use Cloud Search API API for, with concrete tasks.

★ Federated Enterprise Search

Index content from ticketing systems, wikis, and internal databases alongside Google Drive and Gmail so employees see one ranked result list. Cloud Search applies the user's access controls per item, so federation does not weaken existing permissions, and the indexing API supports incremental updates so the corpus stays fresh.

Index a Confluence page as a Cloud Search item under datasource sources/123 with viewer ACLs derived from the page's space permissions

RAG Grounding for Internal Copilots

Use Cloud Search as the retrieval layer for an internal LLM assistant — call the query API with the user's identity and feed the top results as grounding context. Because Cloud Search filters results to documents the user can already see, the assistant cannot leak content the user is not entitled to read, which is critical for regulated workplaces.

Call query.search with the end user's OAuth token for 'Q3 forecast deck' and return the top five items as grounding context

Index Health Monitoring

Pull per-datasource statistics and item indexing status to dashboard the health of your Cloud Search corpus. The API exposes search application stats, query stats, and itemized indexing errors so platform owners can spot stalled connectors and stale indexes before users report bad results.

List items under datasource sources/abc with status=ERROR, group by error code, and post a daily summary to a Slack channel

Agent-Driven Knowledge Lookup

An AI agent can resolve user questions against the organisation's Google Workspace and connected systems by calling Cloud Search through Jentic. The agent searches Jentic for 'search workspace content', loads the query schema, and gets back permission-filtered results scoped to the calling user's identity.

Use Jentic to call query.search with the prompt 'employee handbook PTO policy' and return the top result's URL and snippet

Key Endpoints

45 endpoints — cloud search provides cloud-based search across google workspace data and lets enterprises index third-party content alongside it.

METHOD

PATH

DESCRIPTION

POST

/v1/indexing/{+name}/items:push

Push an item update into a datasource

GET

/v1/indexing/{+name}/items

List indexed items in a datasource

DELETE

/v1/indexing/{+name}

Delete an indexed item

POST

/v1/debug/{+name}:checkAccess

Check whether a principal can access an item

GET

/v1/debug/{+name}/items:searchByViewUrl

Locate an item by its view URL for debugging

POST

/v1/indexing/{+name}/items:push

Push an item update into a datasource

GET

/v1/indexing/{+name}/items

List indexed items in a datasource

DELETE

/v1/indexing/{+name}

Delete an indexed item

POST

/v1/debug/{+name}:checkAccess

Check whether a principal can access an item

GET

/v1/debug/{+name}/items:searchByViewUrl

Locate an item by its view URL for debugging

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Google OAuth 2.0 client credentials and refresh tokens for Cloud Search live encrypted in the Jentic vault. Agents receive only scoped short-lived access tokens — Workspace admin credentials never enter the agent runtime.

Intent-based discovery

Agents search Jentic with intents like 'search workspace content' or 'index document into cloud search' and Jentic returns the matching query or indexing operation along with its request schema.

Time to first call

Direct integration with Cloud Search: 3-7 days for OAuth setup, datasource configuration, and ACL mapping. Through Jentic: under 1 hour — search, load schema, execute against an existing datasource.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Admin SDK API

Manages Workspace users, groups, and OUs that Cloud Search ACLs reference

Use Admin SDK to provision the identities and groups; use Cloud Search to index and query content scoped to those identities

Complementary

Compute Engine API

Hosts the third-party connector workloads that push items into Cloud Search

Run a connector VM or job on Compute Engine when you need to crawl an on-prem source before pushing to Cloud Search

Complementary

Cloud Tasks API

Queues indexing jobs so connectors can rate-limit pushes into Cloud Search

Use Cloud Tasks to throttle large reindexing operations against Cloud Search's per-datasource limits

FAQs

Specific to using Cloud Search API API through Jentic.

What authentication does the Cloud Search API use?

It uses Google OAuth 2.0 with scopes such as https://www.googleapis.com/auth/cloud_search.indexing for indexing flows and https://www.googleapis.com/auth/cloud_search.query for end-user search. Through Jentic the OAuth credentials live in the Jentic vault and only short-lived access tokens are passed to the agent.

Can I index third-party content with the Cloud Search API?

Yes. Create a datasource, push items via the indexing.datasources.items.index endpoint, and supply per-item ACLs so search results respect the original system's permissions. The API supports incremental updates and bulk deletes.

What are the rate limits for the Cloud Search API?

Indexing operations are limited per datasource and per project, and query QPS is governed by the connected Cloud Search license tier. Use the items.list endpoint with pagination rather than re-indexing when reconciling state, and stagger heavy reindexing operations.

How do I run a permission-filtered query through Jentic?

Search Jentic for 'search workspace content', load the query.search schema, and execute the call against /v1/query/search using the end user's OAuth token. Cloud Search filters the results so the user only sees items they are entitled to.

Does Cloud Search require a paid Google Workspace plan?

Yes, Cloud Search is available on specific Workspace editions and as a standalone offering. The API itself has no per-call price but you must have a license and an admin-configured Cloud Search tenant before calls succeed.

Can I retrieve search analytics from the API?

Yes. The stats resource exposes query, session, user, and item-level analytics under /v1/stats endpoints. Use these to dashboard search performance and spot underperforming datasources.