---
title: "Rank mirror candidates with readiness scores, blockers, tool compatibility, and selected safe files."
method: GET
path: "/api/mirror-readiness"
tags: ["Catalog", "Agent Docs"]
---

# Rank mirror candidates with readiness scores, blockers, tool compatibility, and selected safe files.

`GET /api/mirror-readiness`

## Request

- Base URL: `https://huggingbay.xyz`
- URL: `https://huggingbay.xyz/api/mirror-readiness`
- Auth: none declared

Rank mirror candidates with readiness scores, blockers, tool compatibility, and selected safe files.

**Inputs.** Path, query and header fields are listed below. No request body is required.

**Outputs.** See each status below for its media type, schema and headers. A missing record or unavailable capability is not a successful empty result.

**Errors.** API JSON failures use the documented response schema. Read code, message and next; retry only when the response allows it. Auth, invalid input and missing records need a caller change.

**Rate limits.** Public read budgets apply by client IP and route group. This operation can have a smaller route-specific budget. Read Retry-After on 429 or retryable 503 responses.

## Query parameters

- `limit` integer
- `requestedOnly` boolean
- `artifactId` string
- `artifactIds` string

## Response `200`

Mirror readiness report

- MirrorReadinessResponse
  - `schemaVersion` 'hugging-bay.mirror-readiness.v1', required
  - `generatedAt` string, required
  - `baseUrl` string
  - `summary` object, required
  - `policy` object
  - `rows` MirrorDemandRow[], required (unresolved $ref)
  - `agentUse` object

---

[API](https://skmtc.dev/huggingbay/apis/hugging-bay-public-api.md) · [All operations](https://skmtc.dev/huggingbay/apis/hugging-bay-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/huggingbay/apis/hugging-bay-public-api/revisions/ea7ba26b1e27?raw)