---
title: "Compact cached briefing for agents and crawlers."
method: GET
path: "/api/agents/briefing"
tags: ["Catalog", "Agent Docs"]
---

# Compact cached briefing for agents and crawlers.

`GET /api/agents/briefing`

## Request

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

Start here for agent traffic. Returns scale totals, efficient entrypoints, safe workflow, curated packs, topics, mirror candidates, hosted download stats, and crawl guidance.

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

- `compat` 'containment'

## Response `200`

Agent briefing

- AgentBriefing
  - `schemaVersion` 'hugging-bay.agent-briefing.v1', required
  - `generatedAt` string, required
  - `product` object, required
  - `scale` object, required
  - `entrypoints` object, required
  - `safeWorkflow` string[], required
  - `highValueQueries` object[]
  - `packs` MirrorPackSummary[] (unresolved $ref)
  - `topTopics` Topic[] (unresolved $ref)
  - `mirrorCandidates` MirrorDemandRow[] (unresolved $ref)
  - `hostedDownloads` object
  - `trafficGuidance` 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/865eb0f1b6ef?raw)