HTTP API Reference

Embeddings Index API reference

Reference documentation for the Embeddings Index HTTP endpoints.

The Embeddings Index API allows you to create, manage, and query embeddings indexes for semantic search in your Sanity project.

Embeddings Index API is currently in beta. Features and behavior may change without notice.

This is a paid feature

This feature is available in the Growth plan.

Note: Using this feature requires Sanity to send data to OpenAI and Pinecone to store vector interpretations of documents.

Want to get started?

Embeddings index introduction

Embeddings allow you to search for what your documents are about. Use the Embeddings Index API to build LLM agents or to enable semantic search.

Authentication

Known limitations

  • Creating an embeddings index for very large datasets can be slow.
  • The Embeddings Index HTTP API rate limit depends on the OpenAI rate limit, which sets a cap for the HTTP API at about 8,000 tokens per minute.
  • The embeddings-index API does not support dataset aliases—you must use the real dataset name in all requests.

Base API server URL

Embeddings Index API base URL

https://{projectId}.api.sanity.io/{apiVersion}

Variables

  • apiVersionstringdefault: "vX"

    API version

  • projectIdstringdefault: "your-project-id"

    Sanity project ID