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

# For agents

> Everything an AI agent needs to work with Qonversion: a ready-made integration prompt, the MCP server for your project data, the MCP server for these docs, markdown versions of every page, llms.txt, and the REST API.

This section is for AI agents, and for the person pointing one at Qonversion.

Three surfaces, and they do different jobs:

| Surface | Address | Use it to |
| - | - | - |
| **Documentation MCP server** | `https://documentation.qonversion.io/mcp` | let an agent search and read these docs. No account needed. |
| **Qonversion MCP server** | `https://mcp.qonversion.io/mcp` | let an agent read and change your project data. OAuth against your account. |
| **REST API v4** | `https://api.qonversion.io/v4` | call Qonversion from your own backend with a Secret Key. |

## Have an agent integrate the SDK

Paste this into Claude Code, Cursor, Codex or any coding agent working in your app's repository.

<Prompt description="Integrate the Qonversion SDK using the official documentation." icon="robot" actions={["copy", "cursor"]}>
  Integrate the Qonversion SDK into this app.

  Read the official documentation before writing any code. The docs expose an MCP server at [https://documentation.qonversion.io/mcp](https://documentation.qonversion.io/mcp) — use it if you can. Otherwise fetch pages directly; any page is available as markdown by appending `.md` to its URL, and [https://documentation.qonversion.io/llms.txt](https://documentation.qonversion.io/llms.txt) lists every page.

  Steps:

  1. Ask me to confirm that a Qonversion project exists and that the stores or payment platforms this app uses are connected in the dashboard (App Store, Google Play, Stripe or Paddle). This is step 2 of the quick start; nothing validates until it is done. If the app uses Google Play, its credentials can take up to 24 hours to start working. Never ask me to paste store credentials or payment-platform keys into this conversation.
  2. Read `https://documentation.qonversion.io/docs/quickstart.md` and decide with me between Analytics Mode and Subscription Management Mode. Do not pick one silently.
  3. Read the install page for this project's platform, linked from `https://documentation.qonversion.io/docs/install-sdk.md`. Use the SDK version the docs name, not one from memory.
  4. Install and configure the SDK. Ask me for the Qonversion Project key; it is in the dashboard under Settings → Developer → Keys. The Project key is public and ships inside the app; never put a Secret Key (`sk_…`) in the app or the repository.
  5. Implement the mode we chose, following the documented method names exactly.
  6. Show me the diff and tell me what you could not verify against the docs.
</Prompt>

Prefer to do it by hand? The steps are in the [quick start](/docs/quickstart).

## Connect an agent to your project data

The Qonversion MCP server exposes the REST API v4 resource surface as tools: customers, users, identities, purchases, user properties, entitlements, products, remote configurations, experiments, segments, analytics, exports, events, scheduled reports, integrations and project settings, plus Apple Ads reports as a closed beta — the same reports are also readable through REST API v4.

```bash Claude Code theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
claude mcp add --transport http Qonversion https://mcp.qonversion.io/mcp
```

Setup for Claude Desktop, Cursor, VS Code, Windsurf, Zed, Codex and stdio clients: [MCP Server](/docs/mcp-server).

Two things to know before you point an agent at a project:

* **Access mirrors your dashboard role.** The agent authenticates as you over OAuth 2.1, and each tool is gated by its own scope. No API key is handed to the model.
* **Destructive tools stop and ask.** `delete_*`, `revoke_*`, `detach_*` and the deprecated `regenerate_project_secret` return a short-lived token addressed to you, not to the agent, and completing the action requires echoing the resource id verbatim and giving a reason.

## Let an agent read these docs

* **MCP:** `https://documentation.qonversion.io/mcp` — search and fetch pages, no authentication.
* **Markdown of any page:** append `.md` to the URL, for example `https://documentation.qonversion.io/docs/quickstart.md`.
* **Page index:** [`llms.txt`](https://documentation.qonversion.io/llms.txt) — every page, one line each.
* **Whole corpus:** [`llms-full.txt`](https://documentation.qonversion.io/llms-full.txt) — the full text in one file. It is large; prefer the MCP server or single pages when the context window matters.
* **In-page buttons:** every page has a copy control that yields markdown, or hands the page to Claude or ChatGPT.

## Call the API directly

For a backend, a cron job or a warehouse sync, use the REST API v4 with a project Secret Key. Operation ids are verb-based, and errors carry `type`, `code` and field-level detail so an agent can correct itself without parsing prose. Lists paginate, but not all with the same parameters — read the resource guide before writing one pager for everything.

Start at [API reference](/reference/v4/overview). Keep Secret Keys on a server — see [Project keys](/docs/project-keys) — and check the limits that apply to the surface you are calling, in [Rate limits](/docs/rate-limits) for the SDK and in [Apple Ads](/reference/v4/apple-ads) for the Apple Ads report and series.

## Next steps

<CardGroup cols={2}>
  <Card title="MCP & API" icon="plug" href="/docs/mcp-and-api">
    Which surface to pick, and where the two differ.
  </Card>

  <Card title="MCP Server" icon="robot" href="/docs/mcp-server">
    Tool list, per-client setup, scopes, confirmation flow.
  </Card>

  <Card title="Apple Ads via MCP" icon="bullseye" href="/docs/mcp-apple-ads">
    Reading campaign performance from an agent, and the ways the numbers are easy to misread.
  </Card>

  <Card title="llms.txt" icon="file-lines" href="/docs/llmtxt">
    What the file is and where it lives.
  </Card>
</CardGroup>


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