---
title: REST API reference — Agent Ready
description: Reference for the agent-ready.dev REST API. Bearer auth, JSON request/response, OpenAPI 3.1 canonical schema.
last_updated: 2026-05-11
canonical_url: https://agent-ready.dev/docs/api/reference
---

# REST API reference

> Reference for the agent-ready.dev REST API. Bearer-token authentication, JSON request/response, rate-limited per Pro plan. The interactive HTML view at /docs/api/reference uses Scalar (JS-rendered). The canonical machine-readable schema is the OpenAPI 3.1 spec linked below.

## Authentication

All endpoints require a Bearer token in the `Authorization` header:

```
Authorization: Bearer ar_live_xxxxxxxxxxxxxxxxxxxxxx
```

Issue keys from the [dashboard](https://agent-ready.dev/dashboard/api-keys) (Pro plan required).

## Base URL

```
https://agent-ready.dev/api/v1
```

## Endpoints (summary)

- `POST /scan` — start a new scan. Body: `{ url, options? }`. Returns the scan id and a stream of check results.
- `GET /scan/{id}` — fetch a completed scan by id.
- `POST /mcp` — JSON-RPC endpoint for MCP clients.

## Rate limits

- Pro: 10 requests/minute, 200/day.
- Free: API access not included.

## Canonical schema

The full OpenAPI 3.1 specification is published at <https://agent-ready.dev/api/v1/openapi.json> and aliased at <https://agent-ready.dev/openapi.json>.

For an interactive console (Try-it requests, response examples, schema diagrams), use the [HTML reference](https://agent-ready.dev/docs/api/reference). That view is JS-rendered; if you can't execute JS, parse the OpenAPI document above.

## Related

- [API overview](https://agent-ready.dev/docs/api)
- [Pricing](https://agent-ready.dev/pricing)
- [Methodology](https://agent-ready.dev/methodology)

## Sitemap

See the full [sitemap](https://agent-ready.dev/sitemap.md) for all pages on agent-ready.dev.