API reference - AppGoat Docs

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 (no key needed). New to the API? Start with the quickstart and the concepts.

Base URL

https://api.appgoat.ai/v1

Authentication

Send your API key in the x-api-key header. Create a key in the dashboard under API keys.

curl "https://api.appgoat.ai/v1/me" -H "x-api-key: $APPGOAT_API_KEY"

Responses

Every success is { data, meta } (envelope); 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`).
401	Missing or invalid API key (`invalid_api_key`).
402	Out of credits or not in your plan (`insufficient_credits`, `plan_limit`).
404	Unknown endpoint, app, developer or id.
429	Too many requests per second (`rate_limited`).
5xx	Something failed on our side; retry with backoff. Check status.appgoat.ai.

Every endpoint page lists its credit cost; the full table is on Credits.