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

# API Reference

> Every endpoint of the Amoreg REST API, with an interactive playground.

All endpoints live under `https://app.amoreg.com/api/v1` and authenticate with
an organisation API key — see [Authentication](/authentication). The pages in
this tab are generated from the [OpenAPI 3.1 spec](/api/openapi.json), which is
also served live at `https://app.amoreg.com/api/v1/openapi`.

<CardGroup cols={2}>
  <Card title="Search the knowledge base" icon="search" href="/api/search">
    Flat 2p per request, debited from your prepaid balance.
  </Card>

  <Card title="List jurisdictions" icon="globe" href="/api/list-jurisdictions">
    Jurisdictions available to your organisation.
  </Card>

  <Card title="Run a screening" icon="list-checks" href="/api/create-screening">
    Durable background run: reserves 2p per keyword up front, settles the
    actual cost when the run completes, and releases the remainder.
  </Card>

  <Card title="Screening status" icon="loader" href="/api/get-screening">
    Poll a screening run for status and results.
  </Card>

  <Card title="Documents" icon="file-text" href="/api/list-documents">
    List, upload (2p/page), and delete the policy documents behind search.
  </Card>

  <Card title="Run python" icon="square-terminal" href="/api/create-execution">
    Sandboxed execution as a durable run — 5p + 1p per second of runtime.
  </Card>

  <Card title="Credit balance" icon="coins" href="/api/get-credits">
    Current prepaid balance, holds, and available credit.
  </Card>

  <Card title="Credit ledger" icon="receipt-text" href="/api/list-ledger">
    Statement of top-ups, reservations, and settlements.
  </Card>

  <Card title="Top up" icon="credit-card" href="/api/create-top-up">
    Create a Revolut checkout for a prepaid top-up. Minimum £10.
  </Card>
</CardGroup>