> ## 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.

# Operational Evidence

> Transform messy operational evidence into structured reports.

<Badge color="purple" shape="pill">
  Private beta
</Badge>

**From messy evidence to structured operational reports.**

Operational Evidence is a product inside The Wo Developer Platform. It
transforms unstructured real-world evidence into a normalized report that
software systems can consume.

The current MVP accepts text evidence, image URLs, or both together with the
operational context in which the evidence should be interpreted.

It returns a structured result containing:

* title;
* description;
* operational category;
* suggested priority;
* suggested next step;
* tags;
* risk flags;
* confidence;
* usage information for the operation.

## Start here

<Columns cols={2}>
  <Card title="Quickstart" icon="rocket" href="/operational-evidence/quickstart" cta="Create your first report" arrow="true">
    Configure your environment and make the first `POST /v1/evidence/reports`
    request.
  </Card>

  <Card title="Report contract" icon="file-json" href="/operational-evidence/guides/report-contract" cta="Read the contract" arrow="true">
    Understand request fields, supported contexts, response fields, categories, and priorities.
  </Card>

  <Card title="Beta access" icon="key-round" href="/operational-evidence/beta-access" cta="Understand beta access" arrow="true">
    Review the current manual approval and API-key provisioning process before requesting access.
  </Card>

  <Card title="API Reference" icon="braces" href="/operational-evidence/api-reference/overview" cta="Open API Reference" arrow="true">
    Review the machine-readable HTTP contract generated from OpenAPI.
  </Card>
</Columns>

## Product goal

Operational systems frequently receive information that is difficult to use
directly:

* informal maintenance descriptions;
* inspection notes;
* photos without structured context;
* damage reports;
* delivery evidence;
* field observations.

Operational Evidence converts that input into structured operational data
behind a stable The Wo API contract.

The public contract is independent from the AI provider used internally.
Clients do not need to manage prompts, model configuration, provider response
formats, provider-specific error handling, or provider-side image retrieval.

When image evidence is submitted, The Wo retrieves the remote image through its
shared secure remote-resource boundary before report generation. The original
customer-controlled image URL is not delegated to the report provider for an
independent fetch.

## MVP capabilities

The current MVP supports:

* shared The Wo API key authentication;
* text evidence;
* image evidence referenced by absolute HTTP or HTTPS URLs;
* secure remote image retrieval before report-provider execution;
* operational context;
* optional output language guidance;
* synchronous report generation;
* structured operational results;
* Evidence Report persistence;
* usage tracking;
* monthly quota enforcement;
* current monthly usage visibility.

## Current public endpoints

```http theme={null}
POST /v1/evidence/reports
GET /v1/usage/current
```

`POST /v1/evidence/reports` creates a structured Operational Evidence report.

`GET /v1/usage/current` lets the authenticated customer inspect current
monthly usage, quota, and remaining units.

## Current evidence types

The MVP accepts:

* text;
* image URLs.

Audio, video, uploaded binary files, and streamed evidence are not part of the
current public contract.

## Current API lifecycle

A successful report request follows this flow:

```text theme={null}
authenticate
→ validate request
→ apply technical rate limit
→ apply idempotency when requested
→ validate monthly quota
→ securely retrieve remote images when present
→ generate operational report
→ persist completed report
→ record usage
→ return public response
```

Each successfully created Evidence Report currently consumes one
`evidence_report` usage unit.

See [Usage and quotas](/operational-evidence/guides/usage-and-quotas) for the
complete usage and monthly quota behavior.

## Shared platform boundary

Operational Evidence owns its product vocabulary and report-generation
contract.

Shared API-key behavior is documented once at the platform level in
[Authentication](/platform/authentication).

This keeps product documentation focused while allowing additional The Wo API
products to reuse shared platform capabilities later.

## API version

The initial public API uses URL versioning:

```text theme={null}
/v1
```

Backward-incompatible public contract changes must not be introduced silently
inside an existing API version.

## Environment availability

The canonical production API origin is:

```text theme={null}
https://api.thewo.io
```

Customer integrations must use this HTTPS origin unless The Wo explicitly
provides a different environment for a controlled validation activity.

The staging environment is reserved for internal release validation and is not
a customer integration target.

The OpenAPI contract advertises only the canonical production API origin.

## Continue exploring

* [Quickstart](/operational-evidence/quickstart)
* [Report contract](/operational-evidence/guides/report-contract)
* [Usage and quotas](/operational-evidence/guides/usage-and-quotas)
* [Errors](/operational-evidence/guides/errors)
* [TypeScript example](/operational-evidence/examples/typescript)
* [Beta access](/operational-evidence/beta-access)