Ingest API Overview

The Ingest API writes documents directly to a Site Search index through an update endpoint. Use it when your application or ingestion workflow needs code-driven control of the documents it sends for indexing.

Choose the guide that matches your goal:

  • Getting started: Follow Ingesting Data with the Ingest API to find your endpoint and token, send a first document, and check it in Search Preview.
  • API details: Read Ingest API for endpoint, authentication, request, response, and error details.
  • Workflow guidance: Read Ingest API Best Practices for credential use, batching, payload sizing, retries, monitoring, cleanup, and reprocessing.
Articles in this section