---
title: "Compare up to six artifacts side by side."
method: GET
path: "/api/compare"
tags: ["Artifacts", "Agent Docs"]
deprecated: true
---

# Compare up to six artifacts side by side.

`GET /api/compare`

## Request

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

> **Deprecated.**

Alias of /api/v1/compare (recorded; identical handler). Prefer the recorded path: this one already answers with Deprecation and Sunset headers. Accepts ids, id, repos, or repo query values. Values can be Hugging Bay artifact ids or owner/name repositories.

**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

- `ids` string
- `repo` string
- `compat` 'containment'

## Response `200`

Artifact comparison

- CompareArtifacts
  - `schemaVersion` 'hugging-bay.compare.v1', required
  - `generatedAt` string, required
  - `baseUrl` string
  - `count` number
  - `missing` string[]
  - `strongest` object
  - `columns` string[], required
  - `rows` object[], required
  - `guidance` string[], required

## Other responses

- `404`: No artifacts resolved

---

[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/63c474bf0fe4?raw)