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

# Introduction

> Thirteen endpoints: create, poll, enrich, export, idea generation, and Agency client work.

Base URL: `https://preuve.ai`

Every operation below requires an [API key](/authentication) in the `x-preuve-key` header and returns JSON. Errors use a stable `{ error, code }` envelope - see [Errors](/errors). Four discovery resources need no key: [`GET /api/agent`](https://preuve.ai/api/agent) describes the API (auth, costs, limits, endpoints), the OpenAPI 3.1 spec is served as [`/openapi.json`](https://preuve.ai/openapi.json) and [`/openapi.yaml`](https://preuve.ai/openapi.yaml), and the [RFC 9727 catalog](https://preuve.ai/.well-known/api-catalog) links them together.

Getting in costs nothing: connecting the [MCP server](/mcp-server) mints a key over OAuth on a free account, and `scanType: "starter"` runs on the same endpoints for free, so it doubles as the sandbox. Creating a key by hand needs a paid personal plan or membership of a Consultant or Agency workspace with an active subscription or a one-time unlock - see [Authentication](/authentication).

<Warning>
  The interactive playground makes real calls once you paste your key - a `deep` scan sent from
  these pages spends real quota. Use `scanType: "starter"` to explore.
</Warning>

## Endpoints

| Endpoint | Method | Purpose |
| - | - | - |
| `/api/agent/analyses` | POST | Start one analysis |
| `/api/agent/analyses/{id}` | GET | Poll one analysis |
| `/api/agent/analyses/{id}/enrich` | POST | Generate missing core sections + opt-in deep modules |
| `/api/agent/analyses/{id}/export` | GET | Export one completed analysis (`ideas-json`) |
| `/api/agent/analysis-batches` | POST | Start a batch (up to 5 items) |
| `/api/agent/analysis-batches/{batchId}` | GET | Poll a batch |
| `/api/agent/analysis-batches/{batchId}/export` | GET | Export a completed batch |
| `/api/agent/tools/idea-generator` | POST | Generate startup ideas from interests |

Five more reach a Consultant or Agency **workspace** rather than the calling
account, and each needs one of the two Agency scopes, which are never granted
implicitly. See [Agency client projects](/mcp-server#agency-client-projects).

| Endpoint | Method | Scope | Purpose |
| - | - | - | - |
| `/api/agent/agency` | GET | `agency:read` | Workspace, role, project quota, and the client report list |
| `/api/agent/agency/analyses` | POST | `agency:write` | Start a client project on one shared project credit |
| `/api/agent/agency/reports` | GET | `agency:read` | The client report list on its own |
| `/api/agent/agency/reports/{id}` | GET | `agency:read` | Poll one client report |
| `/api/agent/agency/reports/{id}/export` | GET | `agency:read` | Export one completed client report |


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