Google Cloud Firestore API
Browse all Google APIs39
AI ReadinessNon-Ready (F)39/100
Official vendor OpenAPI document · agent-readyStorageDatabaseoauth231 EndpointsREST
For Agents
Read, write, query, and stream document data in Cloud Firestore, plus manage databases, indexes, and backups. Suited for agents that need a scalable NoSQL store with transactional guarantees.
Use for: Retrieve a Firestore document by its full path, Run a structured query across a collection, Commit a batch of writes atomically to Firestore, Begin a transaction and roll it back on error
Not supported: Does not handle SQL queries, relational joins, or analytics aggregation - use BigQuery for analytics and Spanner for SQL workloads; this API is for document storage and queries only.
The Cloud Firestore API provides programmatic access to Google's serverless NoSQL document database. It supports document reads and writes, transactions, structured queries, listen streams, and administrative operations on databases, indexes, and backups. Firestore is designed for automatic scaling and strong consistency at any scale, making it a fit for both mobile apps and server-side workloads.
Install Jentic One Beta
Connect the Cloud Firestore API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Cloud Firestore API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fgoogleapis.com%2Ffirestore" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fgoogleapis.com%2Ffirestore" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Cloud Firestore API.
Read documents by name with strong or eventual consistency via documents.get
Run structured queries against a collection with documents:runQuery
Commit batched writes atomically with documents:commit and documents:batchWrite
Begin and roll back multi-document transactions
Manage Firestore databases, indexes, and field configurations
Schedule and restore backups for disaster recovery
Listen for realtime document changes via documents:listen
Use Cases
Patterns agents use Cloud Firestore API for, with concrete tasks.
★ Server-Side Document Reads and Writes
Backend services need a scalable NoSQL store for user profiles, orders, or session state. Cloud Firestore exposes commit, batchWrite, and runQuery endpoints that give server code transactional document access without managing database servers. Reads return strongly consistent results within a region, and the API scales automatically with traffic.
Call POST /v1/projects/{project}/databases/{database}/documents:commit with a write that creates a user document at users/{uid} and verify the commit time.
Run Structured Queries from a Service
Reporting jobs and back-office tools need to query Firestore by field equality, ranges, and ordering. The runQuery endpoint accepts a structured query proto and streams matching documents back, supporting both ad-hoc reports and scheduled extraction jobs. Composite indexes are managed via the same API so the query plan can be guaranteed.
Call POST /v1/projects/{project}/databases/{database}/documents:runQuery with a structured query that selects orders where status equals 'paid' in the last 24 hours.
Backup and Restore Firestore Databases
Operators need scheduled backups for disaster recovery and point-in-time recovery options. The Firestore API exposes backup schedules and restore operations on the database resource so backups can be created, listed, and used to restore a new database. This supports compliance retention policies and rollback after data corruption.
Call POST /v1/projects/{project}/databases/{database}/backupSchedules to create a daily backup schedule and confirm the schedule id.
Agent-Driven Document Updates
An AI agent acting on a user instruction can read or update a Firestore document through Jentic. The agent searches for the right operation by intent, loads the request schema, and executes commit or runQuery without holding a service account key. This makes Firestore a viable agent-native datastore for application memory or task state.
Use Jentic to search 'update a firestore document', load the documents:commit schema, and execute it to set the status field on a specific document.
Key Endpoints
31 endpoints — the cloud firestore api provides programmatic access to google's serverless nosql document database.
METHOD
PATH
DESCRIPTION
POST
/v1/{+database}/documents:commit
Commit a batch of writes atomically
POST
/v1/{+database}/documents:batchGet
Read multiple documents in one call
POST
/v1/{+database}/documents:beginTransaction
Start a Firestore transaction
POST
/v1/{+database}/documents:rollback
Roll back a transaction
POST
/v1/{+database}/documents:listen
Listen for realtime document changes
GET
/v1/{+name}
Get a single Firestore document
PATCH
/v1/{+name}
Update fields on a Firestore document
POST
/v1/{+database}/documents:commit
Commit a batch of writes atomically
POST
/v1/{+database}/documents:batchGet
Read multiple documents in one call
POST
/v1/{+database}/documents:beginTransaction
Start a Firestore transaction
POST
/v1/{+database}/documents:rollback
Roll back a transaction
POST
/v1/{+database}/documents:listen
Listen for realtime document changes
GET
/v1/{+name}
Get a single Firestore document
PATCH
/v1/{+name}
Update fields on a Firestore document
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
C
Cloud Firestore API
- Non-Ready (F)39/100
43
Foundational Compliance56
Developer Experience & Jentic Compatibility19
AI-Readiness & Agent Experience94
Agent Usability63
Security57
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
43
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: D-Signals: 4
58%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
14%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
56
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: CSignals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
25%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
19
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
76%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
0%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
0%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
63
Security
Trust, risk posture, and security compliance.
Grade: B-Signals: 1
62%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
57
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: C+Signals: 1
57%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Cloud Firestore API by hand means standing up Google OAuth 2.0 with a service account, choosing the datastore or cloud-platform scope, and managing transactions, commits, and batch reads yourself. Through Jentic you install once, import the Cloud Firestore API from the API Directory, store the service-account credential once, and your agent calls it.
Permission scoping
Firestore puts the database and document resource in the URL path (/v1/{database}/documents:commit, /v1/{name}), so a rule can pin your agent to one database: it can read and write documents there and nothing else. You choose the operations it may call, so a document patch is not included unless you add it.
Credential isolation
Your Google service-account credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'commit a Firestore write' or 'query Firestore documents', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Cloud Firestore API through Jentic.
What authentication does the Cloud Firestore API use?
It uses Google OAuth 2.0 with the cloud-platform or datastore scope. Through Jentic, service account credentials are stored encrypted in the vault and the agent gets a scoped bearer token rather than the raw key.
Can I run transactions across multiple documents with this API?
Yes. Begin a transaction with documents:beginTransaction, perform reads, then send writes through documents:commit referencing the transaction id. Use documents:rollback to abort cleanly.
What are the rate limits for the Cloud Firestore API?
Firestore enforces per-database write limits (around 10,000 writes per second per database) and per-document write limits (1 per second sustained). Read throughput scales much higher. Quota errors return HTTP 429 and should be retried with backoff.
How do I query Firestore from an agent through Jentic?
Search Jentic for 'query firestore documents', load the schema for POST /v1/{database}/documents:runQuery, and execute it with a structuredQuery payload describing the from, where, and orderBy clauses.
Does Firestore support realtime updates over this REST API?
Yes, through the documents:listen endpoint, which streams document change events. For most clients the official SDKs are simpler, but the REST listen channel is available for custom integrations.
Is the Cloud Firestore API free?
Firestore has a free daily quota of reads, writes, deletes, and storage. Beyond that it bills per operation and per GB stored. Pricing details are in the Firestore documentation.
Can I limit what my agent is allowed to do with the Cloud Firestore API?
Yes. Because you run Jentic One yourself, your own rules decide which Firestore operations and which service-account credential the agent may use. Firestore carries the database and document resource in the URL path (for example /v1/{database}/documents:commit and /v1/{name}), so you can pin the agent to a single database where it may read and query documents while excluding write paths like documents:commit or a document PATCH unless you explicitly allow them. Nothing outside the operations you approve is callable.
GET STARTED