# Docs Opensearch — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search OpenSearch documentation across multiple versions, retrieve specific page content, discover breaking changes, and navigate the docs structure all from a single interface. Instantly find answers by searching the docs or get a complete overview of available versions and site navigation.

**Category:** Developer Tools | **Website:** [docs.opensearch.org/](https://docs.opensearch.org/) | **Docs:** [parse.bot/marketplace/c5306a0f-5b9c-4e13-9f8f-adf2c2db03ec/docs-opensearch-org-api](https://parse.bot/marketplace/c5306a0f-5b9c-4e13-9f8f-adf2c2db03ec/docs-opensearch-org-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-docs-opensearch-org-api-c5306a0f/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_breaking_changes

Fetches the breaking changes documented for a given version of OpenSearch. Changes are grouped by version context heading and include the specific change description.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `version` | string | No | Documentation version (e.g. 'latest', '3.6', '2.19') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-docs-opensearch-org-api-c5306a0f/get_breaking_changes \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"version":"<string>"}'
```

### get_navigation_tree

Fetches the hierarchical sidebar navigation tree for a specific documentation version. Returns a recursive structure of page titles, URLs, and nested children representing the full documentation structure.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `version` | string | No | Documentation version (e.g. 'latest', '3.6', '2.19') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-docs-opensearch-org-api-c5306a0f/get_navigation_tree \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"version":"<string>"}'
```

### get_page_content

Fetches the full textual content and metadata of a documentation page. Returns structured data including headings hierarchy, code blocks, table of contents, and the complete body text. Each page is identified by its URL path within the documentation site.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `path` | string | Yes | The URL path of the documentation page (e.g. '/latest/query-dsl/', '/latest/install-and-configure/install-opensearch/docker/') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-docs-opensearch-org-api-c5306a0f/get_page_content \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"path":"<string>"}'
```

### get_version_history

Fetches the version history table containing release dates and highlights for all OpenSearch releases. Each entry includes the version number, release date, a summary of highlights, and links to release notes.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `version` | string | No | Documentation version (e.g. 'latest', '3.6', '2.19') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-docs-opensearch-org-api-c5306a0f/get_version_history \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"version":"<string>"}'
```

### list_versions

Returns the full catalog of available documentation versions partitioned into active (currently maintained) and archived sets, along with the identifier for the current latest version. No input parameters required.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-docs-opensearch-org-api-c5306a0f/list_versions \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### search_docs

Full-text search over the OpenSearch documentation corpus. Returns matching pages with titles, URLs, version labels, and content snippets. Results are scoped to a specific documentation version. Pagination is not supported; the server returns all matching results in a single response.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search keyword or phrase |
| `version` | string | No | Documentation version to search in (e.g. 'latest', '3.6', '2.19') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-docs-opensearch-org-api-c5306a0f/search_docs \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>","version":"<string>"}'
```

### summarize_page

Generates a concise summary of a documentation page by extracting the first substantial paragraph and listing key topic headings (h2 and h3). Lighter than get_page_content when only an overview is needed.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `path` | string | Yes | URL path of the documentation page (e.g. '/latest/query-dsl/') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-docs-opensearch-org-api-c5306a0f/summarize_page \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"path":"<string>"}'
```