How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
OpenMetadata

OpenMetadata Search API

APIs related to search and suggest.

Documentation Provider Profile APIs.io OpenAPI GitHub

OpenMetadata Search API is one of 89 APIs that OpenMetadata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Search. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 15 operations across 14 paths, and defines 40 schemas. It is described by OpenAPI 3.0.1, at version 1.13.

Requests are made against 2 base URLs: /api, http://localhost:8585/api.

15 operations 14 paths 40 schemas 1 DELETE9 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.13
Base URL
https://{your-host}/api/v1
Authentication
HTTP Bearer
Contact
OpenMetadata
License
Apache 2.0
Resource Areas
1

Authentication & Security 1

OpenMetadata Search API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 15

Across 14 paths, the API surfaces 15 operations — 1 DELETE, 9 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Search 15

APIs related to search and suggest.

GET
/v1/search/aggregate
Get aggregated fields
getAggregateFields 8 params → 200
POST
/v1/search/aggregate
Get aggregated Search Request
aggregateSearchRequest body → 200
DELETE
/v1/search/stats/orphan
Clean orphan indexes
cleanOrphanIndexes → 200409
GET
/v1/search/export
Export search results as CSV (streaming)
exportSearchResults 9 params → 200
GET
/v1/search/entityTypeCounts
Get exact entity type counts
getEntityTypeCounts 5 params → 200
GET
/v1/search/stats
Get search cluster statistics
getSearchStats → 200
POST
/v1/search/preview
Preview Search Results
previewSearch body → 200
POST
/v1/search/reindexEntities
Only Reindex the selected entities in Elasticsearch.
reindexOnlySelectedEntities. 1 param body → 200400
GET
/v1/search/query
Search entities
searchEntitiesWithQuery 17 params → 200
GET
/v1/search/fieldQuery
Search entities
searchEntitiesWithSpecificFieldAndValue 6 params → 200
GET
/v1/search/sourceUrl
Search entities
searchEntitiesWithSourceUrl 1 param → 200
GET
/v1/search/get/{index}/doc/{id}
Search entities in ES index with Id
searchEntityInEsIndexWithId 2 params → 200
GET
/v1/search/nlq/query
Search entities using Natural Language Query (NLQ)
searchEntitiesWithNLQ 16 params → 200
PUT
/v1/search/templates
Sync all index templates
syncAllIndexTemplates → 200403
PUT
/v1/search/templates/{entityType}
Sync index template for a specific entity type
syncIndexTemplateByEntityType 1 param → 200400403

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are PreviewSearchRequest (13 properties), TagLabel (13 properties), SearchStatsResponse (12 properties), GlobalSettings (10 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
Range
object
4 properties
TitleSection
object
3 properties
AllowedFieldValueBoostFields
object
2 properties 2 required
ExtensionFieldGuidelines
object
3 properties 2 required
FieldBoost
object
3 properties 1 required
CoverImage
object
2 properties
GlobalSettings
object
10 properties
AdditionalSettings
object
PreviewSearchRequest
object
13 properties 3 required
Aggregation
object
4 properties 2 required
AggregationRequest
object
9 properties 1 required
SearchResponse
object
SearchStatsResponse$OrphanIndex
object
3 properties
SearchStatsResponse$IndexStats
object
8 properties
FieldValueBoost
object
5 properties 2 required
SearchSettings
object
6 properties
QueryExample
object
4 properties 2 required
MatchTypeBoostMultipliers
object
3 properties
AllowedSearchFields
object
2 properties 2 required
GuidelineSection
object
2 properties 2 required
Suggest
object
3 properties
TermBoost
object
3 properties 3 required
AssetTypeConfiguration
object
10 properties 1 required
OrphanCleanupResponse
object
2 properties
SearchStatsResponse
object
12 properties
MappingConfiguration
object
3 properties
Style
object
3 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
TagLabelMetadata
object
2 properties
TopHits
object
3 properties
PromptSection
object
3 properties 2 required
NLQConfiguration
object
6 properties
Field
object
8 properties 2 required
Condition
object
1 property
FieldInterpretation
object
2 properties 2 required
EntityReference
object
9 properties 2 required
EntitySpecificInstruction
object
2 properties 2 required
Field__1
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-search-api-openapi.yml Raw ↑

Other APIs OpenMetadata publishes across the network.

OpenMetadata Agent Executions API
AE Profile APIs.io
OpenMetadata AI Applications API
AE Profile APIs.io
OpenMetadata AI Governance Policies API
AE Profile APIs.io
OpenMetadata API Collections API
AE Profile APIs.io
OpenMetadata API Endpoint API
AE Profile APIs.io
OpenMetadata API Services API
AE Profile APIs.io
OpenMetadata Apps API
AE Profile APIs.io
OpenMetadata Audit Logs API
AE Profile APIs.io
OpenMetadata Bots API
AE Profile APIs.io
OpenMetadata ChangeSummary API
AE Profile APIs.io
OpenMetadata Charts API
AE Profile APIs.io
OpenMetadata Classifications API
AE Profile APIs.io
#Search
← Back to O APIs
API Details
ID
openmetadata:openmetadata-search-api
Base URL
https://{your-host}/api/v1
Docs
https://docs.open-metadata.org/latest/main-concepts/metadata-standard/apis
Provider
OpenMetadata
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=openmetadata-search-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/openmetadata-search-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of OpenMetadata Search API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.