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

# API reference

> AppGoat REST API: apps, reviews, metric history, listing changes, keywords, competitors, search, top charts, developers, audits, watches, webhooks, connections, actions and jobs.

This reference is generated from the OpenAPI 3.1 document, the same one the MCP server is built from. Fetch it at [`https://api.appgoat.ai/v1/openapi.json`](https://api.appgoat.ai/v1/openapi.json) (no key needed). New to the API? Start with the [quickstart](https://docs.appgoat.ai/index.md) and the [concepts](https://docs.appgoat.ai/concepts/app-resolver.md).

## Base URL

```bash theme={null}
https://api.appgoat.ai/v1
```

## Authentication

Send your API key in the `x-api-key` header. Create a key in the [dashboard](https://dash.appgoat.ai) under **API keys**.

```bash theme={null}
curl "https://api.appgoat.ai/v1/me" -H "x-api-key: $APPGOAT_API_KEY"
```

## Responses

Every success is `{ data, meta }` ([envelope](https://docs.appgoat.ai/concepts/envelope.md)); every error is `{ error: { code, message, hint, docs } }` with the matching status:

| Status | Meaning |
| - | - |
| 200 / 201 | Success. |
| 202 | A first fetch of an unknown app is still running: `data: null` and a `job_id` to poll. |
| 400 | A parameter is missing or invalid ([`invalid_param`](https://docs.appgoat.ai/errors/invalid_param)). |
| 401 | Missing or invalid API key ([`invalid_api_key`](https://docs.appgoat.ai/errors/invalid_api_key)). |
| 402 | Out of credits or not in your plan ([`insufficient_credits`](https://docs.appgoat.ai/errors/insufficient_credits), [`plan_limit`](https://docs.appgoat.ai/errors/plan_limit)). |
| 404 | Unknown endpoint, app, developer or id. |
| 429 | Too many requests per second ([`rate_limited`](https://docs.appgoat.ai/errors/rate_limited)). |
| 5xx | Something failed on our side; retry with backoff. Check [status.appgoat.ai](https://status.appgoat.ai). |

Every endpoint page lists its credit cost; the full table is on [Credits](https://docs.appgoat.ai/concepts/credits.md).


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