Sanity HTTP API
61
AI ReadinessAI-Aware (B-)61/100
Official vendor OpenAPI document · agent-readyDeveloper ToolsSource ControlapiKey, bearer4 EndpointsREST
For Agents
Programmatically execute a groq query via post (for queries exceeding 11kb url limit), execute a groq query via get. Covers 4 operations with apiKey, bearer authentication.
Use for: I need to execute a groq query via post (for queries exceeding 11kb url limit), I want to execute a groq query via get, Search for apply mutations to documents in a dataset, Find all documents by id, bypassing caching
Not supported: Does not handle payments, communications, or crm - use for developer tools only.
REST API for the Sanity headless CMS platform. Query, mutate, and manage documents and datasets via GROQ queries and mutations. The API exposes 4 endpoints secured with apiKey, bearer authentication.
Install Jentic One Beta
Connect the Sanity HTTP API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Sanity HTTP 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%2Fsanity.io%2Fsanity" | 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%2Fsanity.io%2Fsanity" | 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 Sanity HTTP API.
Execute a GROQ query via POST (for queries exceeding 11KB URL limit)
Apply mutations to documents in a dataset
Get documents by ID, bypassing caching
Query and filter Sanity HTTP API records by parameters
Monitor Sanity HTTP API operational status and events
Use Cases
Patterns agents use Sanity HTTP API for, with concrete tasks.
★ Developer Tools Operations
Use the Sanity HTTP API to perform developer tools operations programmatically. The API provides 4 endpoints covering core functionality including execute a groq query via post (for queries exceeding 11kb url limit), execute a groq query via get, apply mutations to documents in a dataset.
Call POST /data/query/{dataset} to execute a groq query via post (for queries exceeding 11kb url limit)
Automated Data Management
Automate data operations by combining multiple Sanity HTTP API endpoints. Agents can execute a groq query via get and then apply mutations to documents in a dataset in a single workflow.
Call GET /data/query/{dataset} to execute a groq query via get, then verify the result
AI Agent Integration via Jentic
AI agents discover and call Sanity HTTP API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey, bearer tokens manually.
Search Jentic for 'execute a groq query via post (for queries exceeding 11kb url limit)', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
4 endpoints — rest api for the sanity headless cms platform.
METHOD
PATH
DESCRIPTION
POST
/data/query/{dataset}
Execute a GROQ query via POST (for queries exceeding 11KB URL limit)
GET
/data/query/{dataset}
Execute a GROQ query via GET
POST
/data/mutate/{dataset}
Apply mutations to documents in a dataset
GET
/data/doc/{dataset}/{documentIds}
Get documents by ID, bypassing caching
POST
/data/query/{dataset}
Execute a GROQ query via POST (for queries exceeding 11KB URL limit)
GET
/data/query/{dataset}
Execute a GROQ query via GET
POST
/data/mutate/{dataset}
Apply mutations to documents in a dataset
GET
/data/doc/{dataset}/{documentIds}
Get documents by ID, bypassing caching
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.
S
Sanity HTTP API
- AI-Aware (B-)61/100
87
Foundational Compliance63
Developer Experience & Jentic Compatibility41
AI-Readiness & Agent Experience94
Agent Usability55
Security63
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
87
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: ASignals: 4
98%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
50%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
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.
41
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: D-Signals: 4
33%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
75%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
57%
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.
55
Security
Trust, risk posture, and security compliance.
Grade: CSignals: 1
55%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
63
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: B-Signals: 1
62%
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 Sanity HTTP API by hand means handling its token auth, substituting your project id into the host, choosing between the API and apicdn endpoints, and naming the dataset in every query or mutation. Through Jentic you install once, import the Sanity HTTP API from the API Directory, store the token once, and your agent calls it.
Permission scoping
Sanity puts the dataset in the URL path (/data/query/{dataset} and /data/mutate/{dataset}), so a rule can pin your agent to one dataset. You choose the operations it may call, so a write operation like a mutation is not included unless you add it alongside the read query.
Credential isolation
Your Sanity token 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 'run a GROQ query' or 'fetch a document by id', and Jentic returns the matching Sanity HTTP API 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 Sanity HTTP API through Jentic.
What authentication does the Sanity HTTP API use?
The Sanity HTTP API uses apiKey, bearer authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.
Can I execute a groq query via post (for queries exceeding 11kb url limit) with the Sanity HTTP API?
Yes. Use the POST /data/query/{dataset} endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the Sanity HTTP API?
Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.
How do I execute a groq query via post (for queries exceeding 11kb url limit) through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'execute a groq query via post (for queries exceeding 11kb url limit)'. Jentic returns the matching Sanity HTTP API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the Sanity HTTP API have?
The Sanity HTTP API exposes 4 endpoints covering data operations.
Can I limit what my agent is allowed to do with the Sanity HTTP API?
Yes. Because you run Jentic One yourself, your own rules decide which Sanity operations and credentials the agent may use. Sanity puts the dataset in the URL path, so a rule can pin the agent to a single dataset across both /data/query/{dataset} reads and /data/mutate/{dataset} writes. You also choose exactly which operations it may call, so a mutation stays out of reach unless you add it alongside the read query.
GET STARTED