OpenSearch
Search, inspect, and manage OpenSearch indices and documents over the REST API.
Tools
| Name | Description |
|---|---|
validate_connectionValidate OpenSearch credentials with a low-impact cluster info request. | Validate OpenSearch credentials with a low-impact cluster info request. |
list_indicesList OpenSearch indices using the cat indices JSON endpoint. | List OpenSearch indices using the cat indices JSON endpoint. |
get_indexGet OpenSearch index settings, mappings, and aliases for one index. | Get OpenSearch index settings, mappings, and aliases for one index. |
create_indexCreate an OpenSearch index with optional settings, mappings, and aliases. | Create an OpenSearch index with optional settings, mappings, and aliases. |
delete_indexDelete one OpenSearch index. Requires the exact index name to be repeated for confirmation. | Delete one OpenSearch index. Requires the exact index name to be repeated for confirmation. |
search_documentsRun an OpenSearch Query DSL search against an index or all indices. | Run an OpenSearch Query DSL search against an index or all indices. |
index_documentCreate or replace a document in an OpenSearch index. | Create or replace a document in an OpenSearch index. |
update_documentPartially update a document by ID using the OpenSearch update API. | Partially update a document by ID using the OpenSearch update API. |
get_documentRetrieve one OpenSearch document by index and document ID. | Retrieve one OpenSearch document by index and document ID. |
delete_documentDelete one OpenSearch document. Requires the exact document ID to be repeated for confirmation. | Delete one OpenSearch document. Requires the exact document ID to be repeated for confirmation. |
custom_api_callMake a guarded custom call to the configured OpenSearch cluster origin. | Make a guarded custom call to the configured OpenSearch cluster origin. |
Triggers
| Name | Description |
|---|---|
search_results_changedPolls an OpenSearch query and triggers when the top result IDs or versions change. | Polls an OpenSearch query and triggers when the top result IDs or versions change. |
Quick Start
import { WeavzClient } from '@weavz-io/sdk'
const weavz = new WeavzClient({ apiKey: 'wvz_...' })
const result = await weavz.actions.execute('opensearch', 'validate_connection', {
workspaceId: '550e8400-e29b-41d4-a716-446655440000',
integrationAlias: 'opensearch',
input: { /* ... */ },
})Related Integrations
Works well with
Frequently Asked Questions
How do I connect OpenSearch to my app?
Use Weavz Hosted Connect for Custom authentication. Install the SDK, create a connection through the connect portal or API, then execute tools programmatically.
What tools does OpenSearch support?
OpenSearch supports 11 tools including Validate Connection, List Indices, Get Index, Create Index, Delete Index, and more.
Can I use OpenSearch with AI agents?
Yes. Add OpenSearch to an MCP server in Tool Mode or Code Mode. Code Mode provides 3 meta-tools with on-demand API discovery so agents can compose stateful workflows without loading every action schema up front.
Can OpenSearch be used in stateful agent workflows?
Yes. Agents can combine OpenSearch tools with Filesystem, State KV, Human Gates, input partials, and other workspace integrations while keeping execution scoped to the selected workspace or end user.
What authentication does OpenSearch use?
OpenSearch uses Custom. Weavz stores credentials securely and uses them for authorized action execution.
How much does the OpenSearch integration cost?
The OpenSearch integration is included on all Weavz plans including the free tier with 20,000 actions per month. No credit card required.
What triggers does OpenSearch support?
OpenSearch supports 1 triggers including Search Results Changed.
Connect OpenSearch in minutes
Get 20,000 free action executions every month. No credit card required.