# Collate Search Index API

**Canonical:** https://apis.io/apis/collate/collate-search-index-api/  
**Provider:** Collate — https://apis.io/providers/collate/  
**Base URL:** https://sandbox.open-metadata.org/api/v1  
**Documentation:** https://docs.open-metadata.org/latest/api-reference

Collate Search Index API is one of 107 APIs that [Collate](https://apis.io/providers/collate/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Search Index. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

A `SearchIndex` is a index mapping for indexing documents in a `Search Service`.

## Operations (23)

| Method | Path | Summary |
|---|---|---|
| PUT | `/v1/searchIndexes/{id}/followers` | Add a follower |
| GET | `/v1/searchIndexes/{id}/sampleData` | Get sample data |
| PUT | `/v1/searchIndexes/{id}/sampleData` | Add sample data |
| PUT | `/v1/searchIndexes/bulk` | Bulk create or update search indexes |
| GET | `/v1/searchIndexes` | List searchIndexes |
| PUT | `/v1/searchIndexes` | Update SearchIndex |
| POST | `/v1/searchIndexes` | Create a SearchIndex |
| GET | `/v1/searchIndexes/name/{fqn}` | Get a SearchIndex by fully qualified name |
| DELETE | `/v1/searchIndexes/name/{fqn}` | Delete a SearchIndex by fully qualified name |
| PATCH | `/v1/searchIndexes/name/{fqn}` | Update a SearchIndex using name |
| GET | `/v1/searchIndexes/{id}` | Get a SearchIndex by id |
| DELETE | `/v1/searchIndexes/{id}` | Delete a SearchIndex by id |
| PATCH | `/v1/searchIndexes/{id}` | Update a SearchIndex |
| DELETE | `/v1/searchIndexes/async/{id}` | Asynchronously delete a SearchIndex by id |
| DELETE | `/v1/searchIndexes/{id}/followers/{userId}` | Remove a follower |
| DELETE | `/v1/searchIndexes/deleteStale` | Delete stale searchindexes within a scope |
| GET | `/v1/searchIndexes/{id}/context` | Get the AI context for an entity by id |
| GET | `/v1/searchIndexes/name/{fqn}/context` | Get the AI context for an entity by fully qualified name |
| GET | `/v1/searchIndexes/{id}/versions/{version}` | Get a version of the SearchIndex |
| GET | `/v1/searchIndexes/history` | List all entity versions within a time range |
| GET | `/v1/searchIndexes/{id}/versions` | List SearchIndex versions |
| PUT | `/v1/searchIndexes/restore` | Restore a soft deleted SearchIndex |
| PUT | `/v1/searchIndexes/{id}/vote` | Update Vote for a Entity |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/collate/refs/heads/main/openapi/collate-search-index-api-openapi.yml
- **Documentation** — https://docs.open-metadata.org/latest/api-reference
- **APIReference** — https://docs.open-metadata.org/latest/api-reference

## Other Collate APIs (12)

- [Collate Activity Stream API](https://apis.io/apis/collate/collate-activity-stream-api/)
- [Collate Agent Executions API](https://apis.io/apis/collate/collate-agent-executions-api/)
- [Collate AI Applications API](https://apis.io/apis/collate/collate-ai-applications-api/)
- [Collate AI Audit Reports API](https://apis.io/apis/collate/collate-ai-audit-reports-api/)
- [Collate AI Context API](https://apis.io/apis/collate/collate-ai-context-api/)
- [Collate AI Framework Controls API](https://apis.io/apis/collate/collate-ai-framework-controls-api/)
- [Collate AI Governance API](https://apis.io/apis/collate/collate-ai-governance-api/)
- [Collate AI Governance Frameworks API](https://apis.io/apis/collate/collate-ai-governance-frameworks-api/)
- [Collate AI Governance Policies API](https://apis.io/apis/collate/collate-ai-governance-policies-api/)
- [Collate Announcements API](https://apis.io/apis/collate/collate-announcements-api/)
- [Collate API Collections API](https://apis.io/apis/collate/collate-api-collections-api/)
- [Collate API Endpoint API](https://apis.io/apis/collate/collate-api-endpoint-api/)

## Tags

Search Index

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/collate/collate-search-index-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/collate/.