> ## Documentation Index
> Fetch the complete documentation index at: https://docs.thewo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# ClaimReady API Reference

> OpenAPI reference for the ClaimReady v1 triage endpoints.

The ClaimReady API Reference is generated from the OpenAPI contract maintained
with The Wo application.

## Current API version

```text theme={"theme":"github-dark-default"}
v1
```

## Current endpoints

```http theme={"theme":"github-dark-default"}
POST /v1/product-claims/triage
GET /v1/product-claims/{id}
```

POST creates or replays a completed triage and returns Usage metadata. GET
retrieves a customer-owned result without new Usage metadata. ClaimReady is
currently **Coming Soon**; the [product access guide](https://docs.thewo.io/claim-ready/guides/product-access.md)
explains its availability and entitlement requirements.

## Authentication

Protected requests use the shared API key header:

```http theme={"theme":"github-dark-default"}
x-api-key: <your-api-key>
```

POST also requires an `Idempotency-Key`. Keep the key in a trusted server
environment. See [Authentication](https://docs.thewo.io/platform/authentication.md) for creation,
storage, and secrecy guidance.

## OpenAPI contract

The ClaimReady v1 contract is defined in:

```text theme={"theme":"github-dark-default"}
developer-docs/openapi/claim-ready-v1.yaml
```

The interactive operation references below describe request fields,
successful responses, and public errors. For integration guidance, see the
[Quickstart](https://docs.thewo.io/claim-ready/quickstart.md), [Triage contract](https://docs.thewo.io/claim-ready/guides/triage-contract.md),
and [Errors](https://docs.thewo.io/claim-ready/guides/errors.md).

## Production base URL

The canonical production API origin is:

```text theme={"theme":"github-dark-default"}
https://api.thewo.io
```

The OpenAPI specification advertises this production origin. Staging is
reserved for internal The Wo release validation and is not a customer
integration target.

## Contract stability

The OpenAPI specification describes the public HTTP contract; the deployed
application remains the runtime source of truth. Changes to public behavior
must update OpenAPI and developer documentation in the same delivery flow. The
product contract is versioned under `/v1`; backward-incompatible changes must
not be introduced silently within that version.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.