Sanity Query API

openapi: 3.0.3
info:
  title: Sanity HTTP Assets Query API
  description: The Sanity HTTP API provides access to the Sanity Content Lake platform, enabling querying, mutating, and managing structured content. The API supports GROQ queries, real-time event streaming, asset management, project management, webhooks, scheduling, and AI-powered content agents. Authentication uses Bearer tokens generated from Sanity project settings.
  version: v2024-01-01
  contact:
    name: Sanity Support
    url: https://www.sanity.io/docs
  license:
    name: Commercial
    url: https://www.sanity.io/legal/terms
servers:
- url: https://{projectId}.api.sanity.io/v{apiVersion}
  description: Sanity project-scoped API endpoint
  variables:
    projectId:
      description: Your Sanity project ID
      default: your-project-id
    apiVersion:
      description: API version date (YYYY-MM-DD)
      default: '2024-01-01'
- url: https://api.sanity.io/v{apiVersion}
  description: Sanity management API endpoint
  variables:
    apiVersion:
      description: API version date
      default: '2024-01-01'
security:
- BearerAuth: []
tags:
- name: Query
  description: GROQ query operations against Content Lake
paths:
  /data/query/{dataset}:
    get:
      operationId: queryDocuments
      summary: Query Documents
      description: Query Content Lake using GROQ syntax. For queries under 11 KB, submit the query as a URL parameter. Use the CDN endpoint ({projectId}.apicdn.sanity.io) for edge-cached results.
      tags:
      - Query
      parameters:
      - name: dataset
        in: path
        required: true
        schema:
          type: string
        description: Dataset name (e.g., production)
      - name: query
        in: query
        required: true
        schema:
          type: string
        description: GROQ query string
      - name: perspective
        in: query
        schema:
          type: string
          enum:
          - drafts
          - published
          - raw
        description: Content perspective to query
      - name: explain
        in: query
        schema:
          type: boolean
        description: Include query execution plan in response
      - name: resultSourceMap
        in: query
        schema:
          type: boolean
        description: Include content source map metadata
      responses:
        '200':
          description: Query results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponse'
        '400':
          description: Invalid GROQ query
        '401':
          description: Unauthorized
    post:
      operationId: queryDocumentsPost
      summary: Query Documents (POST)
      description: Query Content Lake using GROQ syntax via POST for queries exceeding 11 KB or when query parameters need to be passed in the body.
      tags:
      - Query
      parameters:
      - name: dataset
        in: path
        required: true
        schema:
          type: string
        description: Dataset name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - query
              properties:
                query:
                  type: string
                  description: GROQ query string
                params:
                  type: object
                  description: Query parameters as key-value pairs
                perspective:
                  type: string
                  enum:
                  - drafts
                  - published
                  - raw
      responses:
        '200':
          description: Query results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponse'
components:
  schemas:
    QueryResponse:
      type: object
      properties:
        ms:
          type: integer
          description: Server-side processing time in milliseconds
        query:
          type: string
          description: The submitted query
        result:
          description: Query result (object, array, number, or null)
        syncTags:
          type: array
          items:
            type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Sanity project API token