# Docs Opensearch — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.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 for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/docs-opensearch/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## 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.beta.paywithlocus.com/api/wrapped/credits/docs-opensearch/get-breaking-changes \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/docs-opensearch/get-navigation-tree \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/docs-opensearch/get-page-content \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/docs-opensearch/get-version-history \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/docs-opensearch/list-versions \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/docs-opensearch/search-docs \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -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.beta.paywithlocus.com/api/wrapped/credits/docs-opensearch/summarize-page \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"path":"<string>"}'
```

## Next steps

- [All wrapped API providers](https://beta.paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://beta.paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://beta.paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://beta.paywithlocus.com/agent/index.md): every Locus agent page.