Jentic OSThe workplace. An in-house AI platform for every employeeJentic OneSafe access. Agents reach your systems without holding keysJentic AIRThe foundation. Gets your existing platforms ready for AI
Pricing

GET STARTED

API DirectoryBrowse 10,000+ APIs ready for AI agent integrationDocumentationGuides and API reference

TOOLS

API ScoringCheck your AI readiness using our scorecardArazzo UIVisualize Arazzo workflows as interactive documentationArazzo EditorBuild and edit multi-step API workflows visually

COMMUNITY

GitHubOpen source projects and examplesOpen StandardsBuilt on open specs. Never locked in.
All ResourcesEverything in one placeBlogLatest articles and insightsTech Talk NewsletterAPIs, AI agents, architecture and strategyWebinarsLive sessions and on-demand recordingsReports & WhitepapersOriginal research on enterprise AI
About UsOur mission and teamCareersJoin our teamContactGet in touch
Try it now
Jentic OSJentic OneJentic AIR
Pricing
API DirectoryDocumentationAPI ScoringArazzo UIArazzo EditorGitHubOpen Standards
All ResourcesBlogTech Talk NewsletterWebinarsReports & Whitepapers
About UsCareersContact
Try it now
JenticJentic
Products
  • Jentic OS
  • Jentic One
  • Jentic AIR
For Developers
  • API Directory
  • Documentation
  • GitHub
Company
  • About Jentic
  • Careers
  • Contact Us
  • Trust Centre
ISO/IEC 27001:2022 certification badge issued by Prescient SecurityISO/IEC 27001:2022 certification badge issued by Prescient Security

Information Security Management System

Certified to ISO/IEC 27001:2022 by Prescient Security

AICPA SOC for Service Organizations logoAICPA SOC for Service Organizations logo

SOC 2® Type 1 report

Audited by Prescient Assurance

Terms & Conditions•Privacy Policy•
© 2026 Jentic Technology Ltd. All rights reserved.
2 Grattan Court East, Dublin, D02 VX86, Ireland
Switch to light modeSwitch to dark mode
APIs / Developer Tools / OpenSearch API
OpenSearch API logo

OpenSearch API

59
AI ReadinessFoundational (C+)59/100
See full scorecard
Official vendor OpenAPI document · agent-readyDeveloper ToolsSearch Engineapikey733 EndpointsREST

For Agents

Index documents, run searches, bulk-load data, and manage indices and cluster health on a self-hosted OpenSearch deployment.

Use for: Create an index for a new data set, Index a document into an index, Search an index for matching documents, Bulk-load a batch of documents

Not supported: Does not provision the cluster hardware itself. Use it to index and search documents, manage indices, bulk-load data, and check cluster health on your self-hosted OpenSearch deployment.

OpenSearch is a search and analytics engine, and this API is the full surface for working with a cluster: index documents, run queries, bulk-load data, manage indices and their mappings, and check cluster and node health. An agent can create an index, add or fetch a document, run a search, and read cluster status through the same interface an operator would use. It suits teams building search or log-analytics on self-hosted OpenSearch. Because the deployment is your own, the base URL is your cluster's domain.

Jentic One on GithubView OpenAPI Document

Install Jentic One Beta

Connect the OpenSearch API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the OpenSearch API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

1

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fopensearch.org%2Fopensearch" | sh
2

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fopensearch.org%2Fopensearch" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with OpenSearch API.

Create, read, and delete indices

Index, retrieve, and delete documents

Run searches with the query DSL

Bulk-load and update data in one request

Inspect cluster and node health

List indices and their status with the cat endpoints

Use Cases

Patterns agents use OpenSearch API for, with concrete tasks.

★ Search Queries

An agent answers a user's question against indexed data by calling POST /_search with a query, or GET /_search for a simple lookup. This turns a natural request into a structured search over the cluster.

Run the query with POST /_search and return the matching documents

Document Indexing

A pipeline agent adds records with PUT /{index}/_doc/{id} for single documents and POST /_bulk for batches, keeping the search index current. Bulk requests cut the round trips when loading many records.

Index single records with PUT /{index}/_doc/{id} and batches with POST /_bulk

Index Management

An agent provisions storage by creating an index with PUT /{index} and later removes it with DELETE /{index} when it is no longer needed. This lets a workflow manage its own search space.

Create the index with PUT /{index} and delete it with DELETE /{index} when done

Cluster Health Checks

Before a heavy operation, an agent reads GET /_cluster/health and lists indices with GET /_cat/indices to confirm the cluster is ready. This avoids issuing work against a red or overloaded cluster.

Read GET /_cluster/health and GET /_cat/indices before running heavy work

Key Endpoints

733 endpoints — opensearch is a search and analytics engine, and this api is the full surface for working with a cluster: index documents, run queries, bulk-load data, manage indices and their mappings, and check cluster and node health.

METHOD

PATH

DESCRIPTION

POST

/_search

Run a search query

POST

/_bulk

Bulk-load or update documents

PUT

/{index}

Create an index

GET

/{index}/_doc/{id}

Retrieve a document by id

GET

/_cluster/health

Check cluster health

POST

/_search

Run a search query

POST

/_bulk

Bulk-load or update documents

PUT

/{index}

Create an index

GET

/{index}/_doc/{id}

Retrieve a document by id

GET

/_cluster/health

Check cluster health

Jentic AI Readiness Score

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

O

OpenSearch API Specification

- Foundational (C+)
59/100
81
Foundational Compliance
71
Developer Experience & Jentic Compatibility
80
AI-Readiness & Agent Experience
42
Agent Usability
50
Security
42
AI Discoverability
Powered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.2
Show dimension breakdown
81

Foundational Compliance

Base layer of spec validity and structural soundness.

Grade: ASignals: 4
94%

Lint Results

Aggregated quality score from linter diagnostics, weighted by severity.

100%

Resolution Completeness

Percentage of `$ref` references that resolve successfully.

100%

Specification Validity

Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).

30%

Structural Integrity

Structural correctness score based on schema issues using logarithmic dampening.

71

Developer Experience & Jentic Compatibility

Clarity, completeness, and ingestion readiness for developers and tooling.

Grade: A-Signals: 4
9%

Example Density

How richly the API is illustrated with examples.

100%

Example Validity

Percentage of examples that conform to their schemas.

75%

Response Coverage

Percentage of operations with complete response definitions (success, client error, server error).

100%

Tooling Readiness

Health of API ingestion, bundling, and resolution within Jentic pipelines.

80

AI-Readiness & Agent Experience

Semantic breadth, depth, and agent comprehension for AI systems.

Grade: A-Signals: 4
58%

Description Coverage

Coverage of descriptions across API elements.

100%

Error Standardization

Coverage of RFC 9457 Problem Details for error responses.

100%

OperationId Quality

Coverage, uniqueness, and casing consistency of operationIds for AI inference.

61%

Summary Coverage

Coverage of summaries across operations/tags/info.

42

Agent Usability

Functional utility, complexity comfort, and AI orchestration readiness.

Grade: D-Signals: 1
42%

Complexity Comfort

Agent comfort level based on API operational and structural complexity.

50

Security

Trust, risk posture, and security compliance.

Grade: C-Signals: 1
50%

Authentication Strength

Average quality of security schemes based on authentication method strength (weakest link for OAuth2).

42

AI Discoverability

Findability, semantic richness, and reasoning readiness.

Grade: D-Signals: 1
42%

Descriptive Richness

Clarity and depth of descriptions across API elements.

View full reportHow the score is calculatedMore about the dimensions

Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

Score your own APIScoring CLI agent skill
npx @jentic/api-scorecard-cli score <openapi-url>

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring the OpenSearch API by hand means handling the Authorization header for signed requests, learning a surface of 733 operations across search, documents, indices, and cluster management, and pointing at your own cluster's domain. Through Jentic you install once, import the OpenSearch API from the API Directory, store the credential once, and your agent calls it.

Permission scoping

Because you run Jentic One yourself, you decide which OpenSearch operations the agent may call. Allow read-only search and health operations, for example, and leave index creation, bulk writes, and deletes out of the allowed set unless you add them.

Credential isolation

Your OpenSearch credential is stored once, encrypted, by your own Jentic One instance and injected on the Authorization header at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent, such as 'search an index for matching documents' or 'check cluster health', and Jentic returns the matching OpenSearch operation with its input schema so the agent calls the right endpoint.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Meilisearch API

→

Meilisearch is a lightweight search engine; OpenSearch is a broader search and analytics platform.

Use Meilisearch for simple fast search; use OpenSearch for large-scale search and log analytics.

Complementary

MongoDB Atlas API

→

MongoDB stores primary documents; OpenSearch indexes them for full-text search and analytics.

Keep records in MongoDB and index them into OpenSearch for search over the same data.

Complementary

Redis API

→

Redis serves fast key-value and cache access; OpenSearch handles rich queries over indexed data.

Use Redis for caching and fast lookups; use OpenSearch for full-text and analytical queries.

FAQs

Specific to using OpenSearch API through Jentic.

What can an AI agent do with the OpenSearch API?

An agent can create and delete indices, index and retrieve documents, run searches with the query DSL, bulk-load data, and check cluster and node health. It is the full working surface of a self-hosted OpenSearch cluster.

What authentication does the OpenSearch API use?

The specification declares an apiKey scheme that carries credentials in the Authorization header, which is how a signed request such as AWS SigV4 is presented to a managed OpenSearch endpoint. Through Jentic that credential is held by your own instance and set on the Authorization header at execution time.

What base URL does the OpenSearch API use?

OpenSearch is self-hosted, so the base URL is your own cluster's domain rather than a shared host. You point Jentic at your cluster and it calls the same endpoints described here.

Is there an MCP server for the OpenSearch API?

You do not need a separate MCP server to use the OpenSearch API with an agent. Through Jentic One, the self-hosted execution layer, your agent calls the operations directly after you import them from the API Directory. Install Jentic One from github.com/jentic/jentic-one to run it yourself.

How does my agent discover OpenSearch operations through Jentic?

Agents search Jentic by intent, such as 'search an index for matching documents', and Jentic returns the matching operation with its input schema. The agent then calls the right endpoint without reading the full reference.

Can I limit what my agent is allowed to do with the OpenSearch API?

Yes. Because you run Jentic One yourself, you decide which OpenSearch operations the agent may call. You can allow read-only search and health operations, and leave index creation, bulk writes, and deletes out of the allowed set unless you add them, so the agent acts only within the operations you permit.

GET STARTED

Start building with OpenSearch API

Explore with Jentic One
View OpenAPI Document